1336 lines
55 KiB
JSON
1336 lines
55 KiB
JSON
{
|
|
"id": "home",
|
|
"client": {
|
|
"classes": [],
|
|
"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\") => string"
|
|
],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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\""
|
|
],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"display name"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.Environment",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Environment",
|
|
"description": [],
|
|
"path": "src/plugins/home/public/services/environment/environment.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
{
|
|
"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
|
|
}
|
|
],
|
|
"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,
|
|
"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
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.FeatureCatalogueEntry.category",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [
|
|
"{@link FeatureCatalogueCategory} to display this feature in."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "home",
|
|
"scope": "public",
|
|
"docId": "kibHomePluginApi",
|
|
"section": "def-public.FeatureCatalogueCategory",
|
|
"text": "FeatureCatalogueCategory"
|
|
}
|
|
],
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
{
|
|
"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.ComponentClass<{}, any> | React.FunctionComponent<{}>"
|
|
],
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
{
|
|
"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,
|
|
"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
|
|
}
|
|
],
|
|
"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,
|
|
"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
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
{
|
|
"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
|
|
},
|
|
{
|
|
"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.ComponentClass<{}, any> | React.FunctionComponent<{}>"
|
|
],
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"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
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.FeatureCatalogueCategory",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "FeatureCatalogueCategory",
|
|
"description": [],
|
|
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"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,
|
|
"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,
|
|
"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,
|
|
"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
|
|
},
|
|
{
|
|
"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
|
|
}
|
|
],
|
|
"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,
|
|
"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
|
|
},
|
|
{
|
|
"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
|
|
}
|
|
],
|
|
"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: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }"
|
|
],
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"deprecated": 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,
|
|
"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,
|
|
"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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.OSX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "OSX",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.RPM",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RPM",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.WINDOWS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "WINDOWS",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.DJANGO",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DJANGO",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.RAILS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RAILS",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.JS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "JS",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.JAVA",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "JAVA",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.LINUX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LINUX",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.INSTRUCTION_VARIANT.FLEET",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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,
|
|
"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: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; registerCustomStatusCheck: (name: string, fnCallback: CustomStatusCheckCallback) => void; registerCustomComponent: (name: string, component: CustomComponent) => void; }"
|
|
],
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.HomePublicPluginSetup.addData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "addData",
|
|
"description": [],
|
|
"signature": [
|
|
"{ registerAddDataTab: (tab: ",
|
|
"AddDataTab",
|
|
") => void; }"
|
|
],
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"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,
|
|
"references": [
|
|
{
|
|
"plugin": "cloud",
|
|
"path": "x-pack/plugins/cloud/public/plugin.ts"
|
|
},
|
|
{
|
|
"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,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-public.HomePublicPluginStart.featureCatalogue",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "featureCatalogue",
|
|
"description": [],
|
|
"signature": [
|
|
"FeatureCatalogueRegistry"
|
|
],
|
|
"path": "src/plugins/home/public/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.TutorialsCategory",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "TutorialsCategory",
|
|
"description": [],
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.ArtifactsSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ArtifactsSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly application?: Readonly<{} & { label: string; path: 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,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.InstructionSetSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InstructionSetSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly title?: string | undefined; readonly callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; readonly instructionVariants: Readonly<{} & { 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,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.InstructionsSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "InstructionsSchema",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly params?: Readonly<{ defaultValue?: any; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { 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,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.SampleDataRegistrySetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SampleDataRegistrySetup",
|
|
"description": [],
|
|
"signature": [
|
|
"{ getSampleDatasets: () => ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.Writable",
|
|
"text": "Writable"
|
|
},
|
|
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
|
"SavedObject",
|
|
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
|
|
"SampleDatasetDashboardPanel",
|
|
") => void; }"
|
|
],
|
|
"path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.SampleDatasetProvider",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SampleDatasetProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.Writable",
|
|
"text": "Writable"
|
|
},
|
|
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
|
|
],
|
|
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.TutorialProvider",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TutorialProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
"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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { 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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: 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; } & { id: string; name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { 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,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.TutorialProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"TutorialContext"
|
|
],
|
|
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
|
"deprecated": 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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { 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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { 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<{} & { label: string; path: 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 id: string; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ iconType?: string | undefined; message?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; text?: string | undefined; error?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{} & { 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,
|
|
"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,
|
|
"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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.OSX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "OSX",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.RPM",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RPM",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.WINDOWS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "WINDOWS",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.DJANGO",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DJANGO",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.RAILS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "RAILS",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.JS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "JS",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.JAVA",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "JAVA",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.LINUX",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LINUX",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.INSTRUCTION_VARIANT.FLEET",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FLEET",
|
|
"description": [],
|
|
"path": "src/plugins/home/common/instruction_variant.ts",
|
|
"deprecated": 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,
|
|
"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: ",
|
|
"ScopedTutorialContextFactory",
|
|
") => void; }"
|
|
],
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.HomeServerPluginSetup.sampleData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sampleData",
|
|
"description": [],
|
|
"signature": [
|
|
"{ getSampleDatasets: () => ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.Writable",
|
|
"text": "Writable"
|
|
},
|
|
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
|
"SavedObject",
|
|
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
|
|
"SampleDatasetDashboardPanel",
|
|
") => void; }"
|
|
],
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"deprecated": 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,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.HomeServerPluginStart.tutorials",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "tutorials",
|
|
"description": [],
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "home",
|
|
"id": "def-server.HomeServerPluginStart.sampleData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sampleData",
|
|
"description": [],
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"path": "src/plugins/home/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |