github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/saved_search.devdocs.json

1256 lines
No EOL
42 KiB
JSON
Raw Blame History

{
"id": "savedSearch",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "savedSearch",
"id": "def-public.getSavedSearchFullPathUrl",
"type": "Function",
"tags": [],
"label": "getSavedSearchFullPathUrl",
"description": [],
"signature": [
"(id?: string | undefined) => string"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.getSavedSearchFullPathUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.getSavedSearchUrl",
"type": "Function",
"tags": [],
"label": "getSavedSearchUrl",
"description": [],
"signature": [
"(id?: string | undefined) => string"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.getSavedSearchUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearch",
"type": "Interface",
"tags": [],
"label": "SavedSearch",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearch",
"text": "SavedSearch"
},
" extends ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearch.sharingSavedObjectProps",
"type": "Object",
"tags": [],
"label": "sharingSavedObjectProps",
"description": [],
"signature": [
"{ outcome?: \"exactMatch\" | \"aliasMatch\" | \"conflict\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapMetaInfo",
"type": "Interface",
"tags": [],
"label": "SavedSearchUnwrapMetaInfo",
"description": [],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/to_saved_search.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapMetaInfo.sharingSavedObjectProps",
"type": "Object",
"tags": [],
"label": "sharingSavedObjectProps",
"description": [],
"signature": [
"{ outcome?: \"exactMatch\" | \"aliasMatch\" | \"conflict\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/to_saved_search.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapMetaInfo.managed",
"type": "CompoundType",
"tags": [],
"label": "managed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/to_saved_search.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapResult",
"type": "Interface",
"tags": [],
"label": "SavedSearchUnwrapResult",
"description": [],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/to_saved_search.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapResult.attributes",
"type": "CompoundType",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"Omit<",
"SavedSearchAttributes",
", \"description\"> & { description?: string | undefined; references: ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]; }"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/to_saved_search.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapResult.metaInfo",
"type": "Object",
"tags": [],
"label": "metaInfo",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchUnwrapMetaInfo",
"text": "SavedSearchUnwrapMetaInfo"
},
" | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/to_saved_search.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SaveSavedSearchOptions",
"type": "Interface",
"tags": [],
"label": "SaveSavedSearchOptions",
"description": [],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/save_saved_searches.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SaveSavedSearchOptions.onTitleDuplicate",
"type": "Function",
"tags": [],
"label": "onTitleDuplicate",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/save_saved_searches.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SaveSavedSearchOptions.isTitleDuplicateConfirmed",
"type": "CompoundType",
"tags": [],
"label": "isTitleDuplicateConfirmed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/save_saved_searches.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SaveSavedSearchOptions.copyOnSave",
"type": "CompoundType",
"tags": [],
"label": "copyOnSave",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/save_saved_searches.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "savedSearch",
"id": "def-public.VIEW_MODE",
"type": "Enum",
"tags": [],
"label": "VIEW_MODE",
"description": [],
"path": "src/platform/plugins/shared/saved_search/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchByValueAttributes",
"type": "Type",
"tags": [],
"label": "SavedSearchByValueAttributes",
"description": [],
"signature": [
"Omit<",
"SavedSearchAttributes",
", \"description\"> & { description?: string | undefined; references: ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]; }"
],
"path": "src/platform/plugins/shared/saved_search/public/services/saved_searches/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart",
"type": "Interface",
"tags": [],
"label": "SavedSearchPublicPluginStart",
"description": [
"\nSaved search plugin public Setup contract"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"<Serialized extends boolean = false>(savedSearchId: string, serialized?: Serialized | undefined) => Promise<Serialized extends true ? ",
"SerializableSavedSearch",
" : ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.get.$1",
"type": "string",
"tags": [],
"label": "savedSearchId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.get.$2",
"type": "Uncategorized",
"tags": [],
"label": "serialized",
"description": [],
"signature": [
"Serialized | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.getNew",
"type": "Function",
"tags": [],
"label": "getNew",
"description": [],
"signature": [
"() => ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.getAll",
"type": "Function",
"tags": [],
"label": "getAll",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.SOWithMetadata",
"text": "SOWithMetadata"
},
"<",
"SavedSearchAttributes",
">[]>"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.save",
"type": "Function",
"tags": [],
"label": "save",
"description": [],
"signature": [
"(savedSearch: ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
", options?: ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SaveSavedSearchOptions",
"text": "SaveSavedSearchOptions"
},
" | undefined) => Promise<string | undefined>"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.save.$1",
"type": "CompoundType",
"tags": [],
"label": "savedSearch",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.save.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SaveSavedSearchOptions",
"text": "SaveSavedSearchOptions"
},
" | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.checkForDuplicateTitle",
"type": "Function",
"tags": [],
"label": "checkForDuplicateTitle",
"description": [],
"signature": [
"(props: Pick<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OnSaveProps",
"text": "OnSaveProps"
},
", \"newTitle\" | \"isTitleDuplicateConfirmed\" | \"onTitleDuplicate\">) => Promise<void>"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.checkForDuplicateTitle.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OnSaveProps",
"text": "OnSaveProps"
},
", \"newTitle\" | \"isTitleDuplicateConfirmed\" | \"onTitleDuplicate\">"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.byValueToSavedSearch",
"type": "Function",
"tags": [],
"label": "byValueToSavedSearch",
"description": [],
"signature": [
"<Serialized extends boolean = false>(result: ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchUnwrapResult",
"text": "SavedSearchUnwrapResult"
},
", serialized?: Serialized | undefined) => Promise<Serialized extends true ? ",
"SerializableSavedSearch",
" : ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.byValueToSavedSearch.$1",
"type": "Object",
"tags": [],
"label": "result",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchUnwrapResult",
"text": "SavedSearchUnwrapResult"
}
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.byValueToSavedSearch.$2",
"type": "Uncategorized",
"tags": [],
"label": "serialized",
"description": [],
"signature": [
"Serialized | undefined"
],
"path": "src/platform/plugins/shared/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "savedSearch",
"id": "def-server.getSavedSearch",
"type": "Function",
"tags": [],
"label": "getSavedSearch",
"description": [],
"signature": [
"(savedSearchId: string, deps: GetSavedSearchDependencies) => Promise<",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">"
],
"path": "src/platform/plugins/shared/saved_search/server/services/saved_searches/get_saved_searches.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-server.getSavedSearch.$1",
"type": "string",
"tags": [],
"label": "savedSearchId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/saved_search/server/services/saved_searches/get_saved_searches.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-server.getSavedSearch.$2",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"GetSavedSearchDependencies"
],
"path": "src/platform/plugins/shared/saved_search/server/services/saved_searches/get_saved_searches.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes",
"type": "Function",
"tags": [],
"label": "fromSavedSearchAttributes",
"description": [],
"signature": [
"<Serialized extends boolean = false, ReturnType = Serialized extends true ? ",
"SerializableSavedSearch",
" : ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">(id: string | undefined, attributes: ",
"SavedSearchAttributes",
", tags: string[] | undefined, searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SerializedSearchSourceFields",
"text": "SerializedSearchSourceFields"
},
", managed: boolean, serialized?: Serialized) => ReturnType"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes.$2",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"SavedSearchAttributes"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes.$3",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes.$4",
"type": "CompoundType",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SerializedSearchSourceFields",
"text": "SerializedSearchSourceFields"
}
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes.$5",
"type": "boolean",
"tags": [],
"label": "managed",
"description": [],
"signature": [
"boolean"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes.$6",
"type": "Uncategorized",
"tags": [],
"label": "serialized",
"description": [],
"signature": [
"Serialized"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.getKibanaContextFn",
"type": "Function",
"tags": [],
"label": "getKibanaContextFn",
"description": [],
"signature": [
"(getStartDependencies: (getKibanaRequest: (() => ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) | undefined) => Promise<",
"KibanaContextStartDependencies",
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ExpressionFunctionKibanaContext",
"text": "ExpressionFunctionKibanaContext"
}
],
"path": "src/platform/plugins/shared/saved_search/common/expressions/kibana_context.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.getKibanaContextFn.$1",
"type": "Function",
"tags": [],
"label": "getStartDependencies",
"description": [],
"signature": [
"(getKibanaRequest: (() => ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) | undefined) => Promise<",
"KibanaContextStartDependencies",
">"
],
"path": "src/platform/plugins/shared/saved_search/common/expressions/kibana_context.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.getSavedSearchFullPathUrl",
"type": "Function",
"tags": [],
"label": "getSavedSearchFullPathUrl",
"description": [],
"signature": [
"(id?: string | undefined) => string"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.getSavedSearchFullPathUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.getSavedSearchUrl",
"type": "Function",
"tags": [],
"label": "getSavedSearchUrl",
"description": [],
"signature": [
"(id?: string | undefined) => string"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.getSavedSearchUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.toSavedSearchAttributes",
"type": "Function",
"tags": [],
"label": "toSavedSearchAttributes",
"description": [],
"signature": [
"(savedSearch: ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
", searchSourceJSON: string) => ",
"SavedSearchAttributes"
],
"path": "src/platform/plugins/shared/saved_search/common/service/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.toSavedSearchAttributes.$1",
"type": "CompoundType",
"tags": [],
"label": "savedSearch",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/platform/plugins/shared/saved_search/common/service/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "savedSearch",
"id": "def-common.toSavedSearchAttributes.$2",
"type": "string",
"tags": [],
"label": "searchSourceJSON",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/saved_search/common/service/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "savedSearch",
"id": "def-common.DiscoverGridSettings",
"type": "Interface",
"tags": [],
"label": "DiscoverGridSettings",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.DiscoverGridSettings",
"text": "DiscoverGridSettings"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/platform/plugins/shared/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.DiscoverGridSettings.columns",
"type": "Object",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.DiscoverGridSettingsColumn",
"text": "DiscoverGridSettingsColumn"
},
"> | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.DiscoverGridSettingsColumn",
"type": "Interface",
"tags": [],
"label": "DiscoverGridSettingsColumn",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.DiscoverGridSettingsColumn",
"text": "DiscoverGridSettingsColumn"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/platform/plugins/shared/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.DiscoverGridSettingsColumn.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "savedSearch",
"id": "def-common.VIEW_MODE",
"type": "Enum",
"tags": [],
"label": "VIEW_MODE",
"description": [],
"path": "src/platform/plugins/shared/saved_search/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "savedSearch",
"id": "def-common.LATEST_VERSION",
"type": "number",
"tags": [],
"label": "LATEST_VERSION",
"description": [],
"signature": [
"1"
],
"path": "src/platform/plugins/shared/saved_search/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.MAX_SAVED_SEARCH_SAMPLE_SIZE",
"type": "number",
"tags": [],
"label": "MAX_SAVED_SEARCH_SAMPLE_SIZE",
"description": [],
"signature": [
"10000"
],
"path": "src/platform/plugins/shared/saved_search/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.MIN_SAVED_SEARCH_SAMPLE_SIZE",
"type": "number",
"tags": [],
"label": "MIN_SAVED_SEARCH_SAMPLE_SIZE",
"description": [],
"signature": [
"1"
],
"path": "src/platform/plugins/shared/saved_search/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch",
"type": "Type",
"tags": [],
"label": "SavedSearch",
"description": [],
"signature": [
"Partial<",
"SavedSearchAttributes",
"> & { searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
},
"; id?: string | undefined; tags?: string[] | undefined; managed: boolean; references?: ",
"SavedObjectReference",
"[] | undefined; sharingSavedObjectProps?: { outcome?: \"exactMatch\" | \"aliasMatch\" | \"conflict\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined; }"
],
"path": "src/platform/plugins/shared/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearchType",
"type": "string",
"tags": [],
"label": "SavedSearchType",
"description": [],
"signature": [
"\"search\""
],
"path": "src/platform/plugins/shared/saved_search/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearchTypeDisplayName",
"type": "string",
"tags": [],
"label": "SavedSearchTypeDisplayName",
"description": [],
"signature": [
"\"discover session\""
],
"path": "src/platform/plugins/shared/saved_search/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink