kibana/api_docs/log_explorer.devdocs.json

437 lines
No EOL
14 KiB
JSON

{
"id": "logExplorer",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "logExplorer",
"id": "def-public.LogExplorerStateContainer",
"type": "Interface",
"tags": [],
"label": "LogExplorerStateContainer",
"description": [],
"path": "x-pack/plugins/log_explorer/public/components/log_explorer/log_explorer.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "logExplorer",
"id": "def-public.LogExplorerStateContainer.appState",
"type": "Object",
"tags": [],
"label": "appState",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverAppState",
"text": "DiscoverAppState"
},
" | undefined"
],
"path": "x-pack/plugins/log_explorer/public/components/log_explorer/log_explorer.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "logExplorer",
"id": "def-public.LogExplorerStateContainer.logExplorerState",
"type": "CompoundType",
"tags": [],
"label": "logExplorerState",
"description": [],
"signature": [
"Partial<",
"WithDatasetSelection",
" | (",
"WithDatasetSelection",
" & ",
"WithControlPanels",
") | (",
"WithDatasetSelection",
" & ",
"WithControlPanelGroupAPI",
" & ",
"WithControlPanels",
")> | undefined"
],
"path": "x-pack/plugins/log_explorer/public/components/log_explorer/log_explorer.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "logExplorer",
"id": "def-public.LogExplorerPluginSetup",
"type": "Interface",
"tags": [],
"label": "LogExplorerPluginSetup",
"description": [],
"path": "x-pack/plugins/log_explorer/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "logExplorer",
"id": "def-public.LogExplorerPluginSetup.locators",
"type": "Object",
"tags": [],
"label": "locators",
"description": [],
"signature": [
"LogExplorerLocators"
],
"path": "x-pack/plugins/log_explorer/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "logExplorer",
"id": "def-public.LogExplorerPluginStart",
"type": "Interface",
"tags": [],
"label": "LogExplorerPluginStart",
"description": [],
"path": "x-pack/plugins/log_explorer/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "logExplorer",
"id": "def-public.LogExplorerPluginStart.LogExplorer",
"type": "CompoundType",
"tags": [],
"label": "LogExplorer",
"description": [],
"signature": [
"React.ComponentClass<",
"LogExplorerProps",
", any> | React.FunctionComponent<",
"LogExplorerProps",
">"
],
"path": "x-pack/plugins/log_explorer/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "logExplorer",
"id": "def-common.AllDatasetSelection",
"type": "Class",
"tags": [],
"label": "AllDatasetSelection",
"description": [],
"signature": [
{
"pluginId": "logExplorer",
"scope": "common",
"docId": "kibLogExplorerPluginApi",
"section": "def-common.AllDatasetSelection",
"text": "AllDatasetSelection"
},
" implements ",
"DatasetSelectionStrategy"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/all_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "logExplorer",
"id": "def-common.AllDatasetSelection.selectionType",
"type": "string",
"tags": [],
"label": "selectionType",
"description": [],
"signature": [
"\"all\""
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/all_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "logExplorer",
"id": "def-common.AllDatasetSelection.selection",
"type": "Object",
"tags": [],
"label": "selection",
"description": [],
"signature": [
"{ dataset: ",
"Dataset",
"; }"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/all_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "logExplorer",
"id": "def-common.AllDatasetSelection.toDataviewSpec",
"type": "Function",
"tags": [],
"label": "toDataviewSpec",
"description": [],
"signature": [
"() => { id: string; name: string | undefined; title: string | undefined; }"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/all_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "logExplorer",
"id": "def-common.AllDatasetSelection.toURLSelectionId",
"type": "Function",
"tags": [],
"label": "toURLSelectionId",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/all_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "logExplorer",
"id": "def-common.AllDatasetSelection.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"() => ",
{
"pluginId": "logExplorer",
"scope": "common",
"docId": "kibLogExplorerPluginApi",
"section": "def-common.AllDatasetSelection",
"text": "AllDatasetSelection"
}
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/all_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection",
"type": "Class",
"tags": [],
"label": "UnresolvedDatasetSelection",
"description": [],
"signature": [
{
"pluginId": "logExplorer",
"scope": "common",
"docId": "kibLogExplorerPluginApi",
"section": "def-common.UnresolvedDatasetSelection",
"text": "UnresolvedDatasetSelection"
},
" implements ",
"DatasetSelectionStrategy"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.selectionType",
"type": "string",
"tags": [],
"label": "selectionType",
"description": [],
"signature": [
"\"unresolved\""
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.selection",
"type": "Object",
"tags": [],
"label": "selection",
"description": [],
"signature": [
"{ name?: string | undefined; dataset: ",
"Dataset",
"; }"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.toDataviewSpec",
"type": "Function",
"tags": [],
"label": "toDataviewSpec",
"description": [],
"signature": [
"() => { id: string; name: string | undefined; title: string | undefined; }"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.toURLSelectionId",
"type": "Function",
"tags": [],
"label": "toURLSelectionId",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.fromSelection",
"type": "Function",
"tags": [],
"label": "fromSelection",
"description": [],
"signature": [
"(selection: { name?: string | undefined; } & { dataset: { name: ",
"Branded",
"<string, ",
"IndexPatternBrand",
">; } & { title?: string | undefined; }; }) => ",
{
"pluginId": "logExplorer",
"scope": "common",
"docId": "kibLogExplorerPluginApi",
"section": "def-common.UnresolvedDatasetSelection",
"text": "UnresolvedDatasetSelection"
}
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.fromSelection.$1",
"type": "CompoundType",
"tags": [],
"label": "selection",
"description": [],
"signature": [
"{ name?: string | undefined; } & { dataset: { name: ",
"Branded",
"<string, ",
"IndexPatternBrand",
">; } & { title?: string | undefined; }; }"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(dataset: ",
"Dataset",
") => ",
{
"pluginId": "logExplorer",
"scope": "common",
"docId": "kibLogExplorerPluginApi",
"section": "def-common.UnresolvedDatasetSelection",
"text": "UnresolvedDatasetSelection"
}
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "logExplorer",
"id": "def-common.UnresolvedDatasetSelection.create.$1",
"type": "Object",
"tags": [],
"label": "dataset",
"description": [],
"signature": [
"Dataset"
],
"path": "x-pack/plugins/log_explorer/common/dataset_selection/unresolved_dataset_selection.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}