{ "id": "home", "client": { "classes": [ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry", "type": "Class", "tags": [], "label": "FeatureCatalogueRegistry", "description": [], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "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; }" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "({ capabilities }: { capabilities: ", { "pluginId": "@kbn/core-capabilities-common", "scope": "common", "docId": "kibKbnCoreCapabilitiesCommonPluginApi", "section": "def-common.Capabilities", "text": "Capabilities" }, "; }) => void" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.start.$1", "type": "Object", "tags": [], "label": "{ capabilities }", "description": [], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.start.$1.capabilities", "type": "Object", "tags": [], "label": "capabilities", "description": [], "signature": [ { "pluginId": "@kbn/core-capabilities-common", "scope": "common", "docId": "kibKbnCoreCapabilitiesCommonPluginApi", "section": "def-common.Capabilities", "text": "Capabilities" } ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "() => ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.FeatureCatalogueEntry", "text": "FeatureCatalogueEntry" }, "[]" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.getSolutions", "type": "Function", "tags": [], "label": "getSolutions", "description": [], "signature": [ "() => ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.FeatureCatalogueSolution", "text": "FeatureCatalogueSolution" }, "[]" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.removeFeature", "type": "Function", "tags": [], "label": "removeFeature", "description": [], "signature": [ "(appId: string) => void" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueRegistry.removeFeature.$1", "type": "string", "tags": [], "label": "appId", "description": [], "signature": [ "string" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "home", "id": "def-public.getDisplayText", "type": "Function", "tags": [ "params", "return" ], "label": "getDisplayText", "description": [ "\nConvert instruction variant id into display text.\n" ], "signature": [ "(id: \"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\" | \"FLEET\" | \"OPEN_TELEMETRY\") => any" ], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.getDisplayText.$1", "type": "CompoundType", "tags": [], "label": "id", "description": [], "signature": [ "\"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\" | \"FLEET\" | \"OPEN_TELEMETRY\"" ], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "display name" ], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "home", "id": "def-public.AddDataTab", "type": "Interface", "tags": [], "label": "AddDataTab", "description": [], "path": "src/plugins/home/public/services/add_data/add_data_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.AddDataTab.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/home/public/services/add_data/add_data_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.AddDataTab.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/home/public/services/add_data/add_data_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.AddDataTab.component", "type": "Function", "tags": [], "label": "component", "description": [], "signature": [ "React.FunctionComponent<{}>" ], "path": "src/plugins/home/public/services/add_data/add_data_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "home", "id": "def-public.AddDataTab.component.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.AddDataTab.component.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.Environment", "type": "Interface", "tags": [], "label": "Environment", "description": [], "path": "src/plugins/home/public/services/environment/environment.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.Environment.cloud", "type": "boolean", "tags": [], "label": "cloud", "description": [ "\nFlag whether the home app should advertise cloud features" ], "path": "src/plugins/home/public/services/environment/environment.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.Environment.apmUi", "type": "boolean", "tags": [], "label": "apmUi", "description": [ "\nFlag whether the home app should advertise apm features" ], "path": "src/plugins/home/public/services/environment/environment.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.Environment.ml", "type": "boolean", "tags": [], "label": "ml", "description": [ "\nFlag whether the home app should advertise ml features" ], "path": "src/plugins/home/public/services/environment/environment.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry", "type": "Interface", "tags": [], "label": "FeatureCatalogueEntry", "description": [], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.id", "type": "string", "tags": [], "label": "id", "description": [ "Unique string identifier for this feature." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.title", "type": "string", "tags": [], "label": "title", "description": [ "Title of feature displayed to the user." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.category", "type": "CompoundType", "tags": [], "label": "category", "description": [ "{@link FeatureCatalogueCategory} to display this feature in." ], "signature": [ "\"data\" | \"other\" | \"admin\"" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.subtitle", "type": "string", "tags": [], "label": "subtitle", "description": [ "A tagline of feature displayed to the user." ], "signature": [ "string | undefined" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.description", "type": "string", "tags": [], "label": "description", "description": [ "One-line description of feature displayed to the user." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.icon", "type": "CompoundType", "tags": [], "label": "icon", "description": [ "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." ], "signature": [ "string | React.ComponentType<{}>" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.path", "type": "string", "tags": [], "label": "path", "description": [ "URL path to link to this future. Should not include the basePath." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.showOnHomePage", "type": "boolean", "tags": [], "label": "showOnHomePage", "description": [ "Whether or not this link should be shown on the front page of Kibana." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.order", "type": "number", "tags": [], "label": "order", "description": [ "An ordinal used to sort features relative to one another for display on the home page" ], "signature": [ "number | undefined" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.visible", "type": "Function", "tags": [], "label": "visible", "description": [ "Optional function to control visibility of this feature." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.solutionId", "type": "string", "tags": [], "label": "solutionId", "description": [ "Unique string identifier of the solution this feature belongs to" ], "signature": [ "string | undefined" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution", "type": "Interface", "tags": [], "label": "FeatureCatalogueSolution", "description": [], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.id", "type": "string", "tags": [], "label": "id", "description": [ "Unique string identifier for this solution." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.title", "type": "string", "tags": [], "label": "title", "description": [ "Title of solution displayed to the user." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.description", "type": "string", "tags": [], "label": "description", "description": [ "One-line description of the solution displayed to the user." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.icon", "type": "CompoundType", "tags": [], "label": "icon", "description": [ "EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement." ], "signature": [ "string | React.ComponentType<{}>" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.path", "type": "string", "tags": [], "label": "path", "description": [ "URL path to link to this future. Should not include the basePath." ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSolution.order", "type": "number", "tags": [], "label": "order", "description": [ "An ordinal used to sort solutions relative to one another for display on the home page" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.WelcomeServiceSetup", "type": "Interface", "tags": [], "label": "WelcomeServiceSetup", "description": [], "path": "src/plugins/home/public/services/welcome/welcome_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.WelcomeServiceSetup.registerOnRendered", "type": "Function", "tags": [], "label": "registerOnRendered", "description": [ "\nRegister listeners to be called when the Welcome component is mounted.\nIt can be called multiple times to register multiple listeners." ], "signature": [ "(onRendered: () => void) => void" ], "path": "src/plugins/home/public/services/welcome/welcome_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.WelcomeServiceSetup.registerOnRendered.$1", "type": "Function", "tags": [], "label": "onRendered", "description": [], "signature": [ "() => void" ], "path": "src/plugins/home/public/services/welcome/welcome_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "home", "id": "def-public.WelcomeServiceSetup.registerTelemetryNoticeRenderer", "type": "Function", "tags": [], "label": "registerTelemetryNoticeRenderer", "description": [ "\nRegister a renderer of the telemetry notice to be shown below the Welcome page." ], "signature": [ "(renderTelemetryNotice: ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.WelcomeRenderTelemetryNotice", "text": "WelcomeRenderTelemetryNotice" }, ") => void" ], "path": "src/plugins/home/public/services/welcome/welcome_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.WelcomeServiceSetup.registerTelemetryNoticeRenderer.$1", "type": "Function", "tags": [], "label": "renderTelemetryNotice", "description": [], "signature": [ { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.WelcomeRenderTelemetryNotice", "text": "WelcomeRenderTelemetryNotice" } ], "path": "src/plugins/home/public/services/welcome/welcome_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "home", "id": "def-public.EnvironmentSetup", "type": "Type", "tags": [], "label": "EnvironmentSetup", "description": [], "signature": [ "{ update: (update: Partial<", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.Environment", "text": "Environment" }, ">) => void; }" ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueCategory", "type": "Type", "tags": [], "label": "FeatureCatalogueCategory", "description": [], "signature": [ "\"data\" | \"other\" | \"admin\"" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSetup", "type": "Type", "tags": [], "label": "FeatureCatalogueSetup", "description": [], "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; }" ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.TutorialDirectoryHeaderLinkComponent", "type": "Type", "tags": [], "label": "TutorialDirectoryHeaderLinkComponent", "description": [], "signature": [ "React.FunctionComponent<{}>" ], "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "home", "id": "def-public.TutorialDirectoryHeaderLinkComponent.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.TutorialDirectoryHeaderLinkComponent.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.TutorialModuleNoticeComponent", "type": "Type", "tags": [], "label": "TutorialModuleNoticeComponent", "description": [], "signature": [ "React.FunctionComponent<{ moduleName: string; }>" ], "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "home", "id": "def-public.TutorialModuleNoticeComponent.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.TutorialModuleNoticeComponent.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.TutorialSetup", "type": "Type", "tags": [], "label": "TutorialSetup", "description": [], "signature": [ "{ setVariable: (key: string, value: unknown) => void; registerDirectoryHeaderLink: (id: string, component: ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.TutorialDirectoryHeaderLinkComponent", "text": "TutorialDirectoryHeaderLinkComponent" }, ") => void; registerModuleNotice: (id: string, component: ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.TutorialModuleNoticeComponent", "text": "TutorialModuleNoticeComponent" }, ") => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }" ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.TutorialVariables", "type": "Type", "tags": [], "label": "TutorialVariables", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-public.WelcomeRenderTelemetryNotice", "type": "Type", "tags": [], "label": "WelcomeRenderTelemetryNotice", "description": [], "signature": [ "() => JSX.Element | null" ], "path": "src/plugins/home/public/services/welcome/welcome_service.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [], "initialIsOpen": false } ], "objects": [ { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT", "type": "Object", "tags": [], "label": "INSTRUCTION_VARIANT", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.ESC", "type": "string", "tags": [], "label": "ESC", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.OSX", "type": "string", "tags": [], "label": "OSX", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DEB", "type": "string", "tags": [], "label": "DEB", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.RPM", "type": "string", "tags": [], "label": "RPM", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DOCKER", "type": "string", "tags": [], "label": "DOCKER", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.WINDOWS", "type": "string", "tags": [], "label": "WINDOWS", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.NODE", "type": "string", "tags": [], "label": "NODE", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DJANGO", "type": "string", "tags": [], "label": "DJANGO", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.FLASK", "type": "string", "tags": [], "label": "FLASK", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.RAILS", "type": "string", "tags": [], "label": "RAILS", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.RACK", "type": "string", "tags": [], "label": "RACK", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.JS", "type": "string", "tags": [], "label": "JS", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.GO", "type": "string", "tags": [], "label": "GO", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.JAVA", "type": "string", "tags": [], "label": "JAVA", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.DOTNET", "type": "string", "tags": [], "label": "DOTNET", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.LINUX", "type": "string", "tags": [], "label": "LINUX", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.PHP", "type": "string", "tags": [], "label": "PHP", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.FLEET", "type": "string", "tags": [], "label": "FLEET", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.INSTRUCTION_VARIANT.OPEN_TELEMETRY", "type": "string", "tags": [], "label": "OPEN_TELEMETRY", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "setup": { "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup", "type": "Interface", "tags": [], "label": "HomePublicPluginSetup", "description": [], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup.tutorials", "type": "Object", "tags": [], "label": "tutorials", "description": [], "signature": [ "{ setVariable: (key: string, value: unknown) => void; registerDirectoryHeaderLink: (id: string, component: ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.TutorialDirectoryHeaderLinkComponent", "text": "TutorialDirectoryHeaderLinkComponent" }, ") => void; registerModuleNotice: (id: string, component: ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.TutorialModuleNoticeComponent", "text": "TutorialModuleNoticeComponent" }, ") => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }" ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup.addData", "type": "Object", "tags": [], "label": "addData", "description": [], "signature": [ "{ registerAddDataTab: (tab: ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.AddDataTab", "text": "AddDataTab" }, ") => void; }" ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup.featureCatalogue", "type": "Object", "tags": [], "label": "featureCatalogue", "description": [], "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; }" ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup.welcomeScreen", "type": "Object", "tags": [], "label": "welcomeScreen", "description": [], "signature": [ { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.WelcomeServiceSetup", "text": "WelcomeServiceSetup" } ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-public.HomePublicPluginSetup.environment", "type": "Object", "tags": [ "deprecated" ], "label": "environment", "description": [ "\nThe environment service is only available for a transition period and will\nbe replaced by display specific extension points." ], "signature": [ "{ update: (update: Partial<", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.Environment", "text": "Environment" }, ">) => void; }" ], "path": "src/plugins/home/public/plugin.ts", "deprecated": true, "removeBy": "8.8.0", "trackAdoption": false, "references": [ { "plugin": "apm", "path": "x-pack/plugins/apm/public/plugin.ts" } ] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "home", "id": "def-public.HomePublicPluginStart", "type": "Interface", "tags": [], "label": "HomePublicPluginStart", "description": [], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-public.HomePublicPluginStart.featureCatalogue", "type": "Object", "tags": [], "label": "featureCatalogue", "description": [], "signature": [ { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", "section": "def-public.FeatureCatalogueRegistry", "text": "FeatureCatalogueRegistry" } ], "path": "src/plugins/home/public/plugin.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "home", "id": "def-server.AppLinkData", "type": "Interface", "tags": [], "label": "AppLinkData", "description": [ "\nThis type is used by consumers to register a new app link for a sample dataset." ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.AppLinkData.sampleObject", "type": "CompoundType", "tags": [], "label": "sampleObject", "description": [ "\nThe sample object that is used for this app link's path; if the path does not use an object ID, set this to null." ], "signature": [ { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.SampleObject", "text": "SampleObject" }, " | null" ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.AppLinkData.getPath", "type": "Function", "tags": [], "label": "getPath", "description": [ "\nFunction that returns the path for this app link. Note that the `objectId` can be different than the given `sampleObject.id`, depending\non how the sample data was installed. If the `sampleObject` is null, the `objectId` argument will be an empty string." ], "signature": [ "(objectId: string) => string" ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.AppLinkData.getPath.$1", "type": "string", "tags": [], "label": "objectId", "description": [], "signature": [ "string" ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "home", "id": "def-server.AppLinkData.label", "type": "string", "tags": [], "label": "label", "description": [ "\nThe label for this app link." ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.AppLinkData.icon", "type": "string", "tags": [], "label": "icon", "description": [ "\nThe icon for this app link." ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.AppLinkData.order", "type": "number", "tags": [], "label": "order", "description": [ "\nIndex of the links (ascending order, smallest will be displayed first).\nUsed for ordering in the dropdown.\n" ], "signature": [ "number | undefined" ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.SampleDatasetDashboardPanel", "type": "Interface", "tags": [], "label": "SampleDatasetDashboardPanel", "description": [], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.SampleDatasetDashboardPanel.sampleDataId", "type": "string", "tags": [], "label": "sampleDataId", "description": [], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.SampleDatasetDashboardPanel.dashboardId", "type": "string", "tags": [], "label": "dashboardId", "description": [], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.SampleDatasetDashboardPanel.oldEmbeddableId", "type": "string", "tags": [], "label": "oldEmbeddableId", "description": [], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.SampleDatasetDashboardPanel.embeddableId", "type": "string", "tags": [], "label": "embeddableId", "description": [], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.SampleDatasetDashboardPanel.embeddableType", "type": "Enum", "tags": [], "label": "embeddableType", "description": [], "signature": [ { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.EmbeddableTypes", "text": "EmbeddableTypes" } ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.SampleDatasetDashboardPanel.embeddableConfig", "type": "Uncategorized", "tags": [], "label": "embeddableConfig", "description": [], "signature": [ "object" ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.SampleObject", "type": "Interface", "tags": [], "label": "SampleObject", "description": [ "This type is used to identify an object in a sample dataset." ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.SampleObject.type", "type": "string", "tags": [], "label": "type", "description": [ "The type of the sample object." ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.SampleObject.id", "type": "string", "tags": [], "label": "id", "description": [ "The ID of the sample object." ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.TutorialContext", "type": "Interface", "tags": [], "label": "TutorialContext", "description": [], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.TutorialContext.kibanaBranch", "type": "string", "tags": [], "label": "kibanaBranch", "description": [], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.TutorialContext.Unnamed", "type": "IndexSignature", "tags": [], "label": "[key: string]: unknown", "description": [], "signature": [ "[key: string]: unknown" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "home", "id": "def-server.EmbeddableTypes", "type": "Enum", "tags": [], "label": "EmbeddableTypes", "description": [], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.TutorialsCategory", "type": "Enum", "tags": [], "label": "TutorialsCategory", "description": [], "path": "src/plugins/home/common/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "home", "id": "def-server.ArtifactsSchema", "type": "Type", "tags": [], "label": "ArtifactsSchema", "description": [], "signature": [ "{ readonly application?: Readonly<{} & { path: string; label: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.InstructionSetSchema", "type": "Type", "tags": [], "label": "InstructionSetSchema", "description": [], "signature": [ "{ readonly title?: string | undefined; readonly callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; readonly instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.InstructionsSchema", "type": "Type", "tags": [], "label": "InstructionsSchema", "description": [], "signature": [ "{ readonly params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.SampleDataRegistrySetup", "type": "Type", "tags": [], "label": "SampleDataRegistrySetup", "description": [], "signature": [ "{ getSampleDatasets: () => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.Writable", "text": "Writable" }, "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{ isDataStream?: boolean | undefined; } & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObject", "text": "SavedObject" }, "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.AppLinkData", "text": "AppLinkData" }, "[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.SampleDatasetDashboardPanel", "text": "SampleDatasetDashboardPanel" }, ") => void; }" ], "path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.SampleDatasetProvider", "type": "Type", "tags": [], "label": "SampleDatasetProvider", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.Writable", "text": "Writable" }, "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{ isDataStream?: boolean | undefined; } & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>" ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.ScopedTutorialContextFactory", "type": "Type", "tags": [], "label": "ScopedTutorialContextFactory", "description": [], "signature": [ "(...args: any[]) => any" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "home", "id": "def-server.ScopedTutorialContextFactory.$1", "type": "Array", "tags": [], "label": "args", "description": [], "signature": [ "any[]" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.TutorialProvider", "type": "Type", "tags": [], "label": "TutorialProvider", "description": [], "signature": [ "(context: ", { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.TutorialContext", "text": "TutorialContext" }, ") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { name: string; category: \"metrics\" | \"other\" | \"security\" | \"logging\"; id: string; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "home", "id": "def-server.TutorialProvider.$1", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.TutorialContext", "text": "TutorialContext" } ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "home", "id": "def-server.TutorialSchema", "type": "Type", "tags": [], "label": "TutorialSchema", "description": [], "signature": [ "{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly name: string; readonly category: \"metrics\" | \"other\" | \"security\" | \"logging\"; readonly id: string; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT", "type": "Object", "tags": [], "label": "INSTRUCTION_VARIANT", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.ESC", "type": "string", "tags": [], "label": "ESC", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.OSX", "type": "string", "tags": [], "label": "OSX", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DEB", "type": "string", "tags": [], "label": "DEB", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.RPM", "type": "string", "tags": [], "label": "RPM", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DOCKER", "type": "string", "tags": [], "label": "DOCKER", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.WINDOWS", "type": "string", "tags": [], "label": "WINDOWS", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.NODE", "type": "string", "tags": [], "label": "NODE", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DJANGO", "type": "string", "tags": [], "label": "DJANGO", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.FLASK", "type": "string", "tags": [], "label": "FLASK", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.RAILS", "type": "string", "tags": [], "label": "RAILS", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.RACK", "type": "string", "tags": [], "label": "RACK", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.JS", "type": "string", "tags": [], "label": "JS", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.GO", "type": "string", "tags": [], "label": "GO", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.JAVA", "type": "string", "tags": [], "label": "JAVA", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.DOTNET", "type": "string", "tags": [], "label": "DOTNET", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.LINUX", "type": "string", "tags": [], "label": "LINUX", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.PHP", "type": "string", "tags": [], "label": "PHP", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.FLEET", "type": "string", "tags": [], "label": "FLEET", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.INSTRUCTION_VARIANT.OPEN_TELEMETRY", "type": "string", "tags": [], "label": "OPEN_TELEMETRY", "description": [], "path": "src/plugins/home/common/instruction_variant.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "setup": { "parentPluginId": "home", "id": "def-server.HomeServerPluginSetup", "type": "Interface", "tags": [], "label": "HomeServerPluginSetup", "description": [], "path": "src/plugins/home/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.HomeServerPluginSetup.tutorials", "type": "Object", "tags": [], "label": "tutorials", "description": [], "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; }" ], "path": "src/plugins/home/server/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.HomeServerPluginSetup.sampleData", "type": "Object", "tags": [], "label": "sampleData", "description": [], "signature": [ "{ getSampleDatasets: () => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.Writable", "text": "Writable" }, "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{ isDataStream?: boolean | undefined; } & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObject", "text": "SavedObject" }, "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.AppLinkData", "text": "AppLinkData" }, "[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", { "pluginId": "home", "scope": "server", "docId": "kibHomePluginApi", "section": "def-server.SampleDatasetDashboardPanel", "text": "SampleDatasetDashboardPanel" }, ") => void; }" ], "path": "src/plugins/home/server/plugin.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "home", "id": "def-server.HomeServerPluginStart", "type": "Interface", "tags": [], "label": "HomeServerPluginStart", "description": [], "path": "src/plugins/home/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "home", "id": "def-server.HomeServerPluginStart.tutorials", "type": "Object", "tags": [], "label": "tutorials", "description": [], "signature": [ "{}" ], "path": "src/plugins/home/server/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "home", "id": "def-server.HomeServerPluginStart.sampleData", "type": "Object", "tags": [], "label": "sampleData", "description": [], "signature": [ "{}" ], "path": "src/plugins/home/server/plugin.ts", "deprecated": false, "trackAdoption": false } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }