kibana/api_docs/saved_search.devdocs.json

1610 lines
No EOL
53 KiB
JSON

{
"id": "savedSearch",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "savedSearch",
"id": "def-public.getSavedSearchFullPathUrl",
"type": "Function",
"tags": [],
"label": "getSavedSearchFullPathUrl",
"description": [],
"signature": [
"(id?: string | undefined) => string"
],
"path": "src/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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?: \"conflict\" | \"exactMatch\" | \"aliasMatch\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined"
],
"path": "src/plugins/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/plugins/saved_search/public/services/saved_searches/saved_search_attribute_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapMetaInfo.sharingSavedObjectProps",
"type": "Object",
"tags": [],
"label": "sharingSavedObjectProps",
"description": [],
"signature": [
"{ outcome?: \"conflict\" | \"exactMatch\" | \"aliasMatch\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined"
],
"path": "src/plugins/saved_search/public/services/saved_searches/saved_search_attribute_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchUnwrapResult",
"type": "Interface",
"tags": [],
"label": "SavedSearchUnwrapResult",
"description": [],
"path": "src/plugins/saved_search/public/services/saved_searches/saved_search_attribute_service.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": "common",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-common.Reference",
"text": "Reference"
},
"[]; }"
],
"path": "src/plugins/saved_search/public/services/saved_searches/saved_search_attribute_service.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/plugins/saved_search/public/services/saved_searches/saved_search_attribute_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SaveSavedSearchOptions",
"type": "Interface",
"tags": [],
"label": "SaveSavedSearchOptions",
"description": [],
"path": "src/plugins/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/plugins/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/plugins/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/plugins/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/plugins/saved_search/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchAttributeService",
"type": "Type",
"tags": [],
"label": "SavedSearchAttributeService",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.AttributeService",
"text": "AttributeService"
},
"<",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchByValueAttributes",
"text": "SavedSearchByValueAttributes"
},
", ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SearchByValueInput",
"text": "SearchByValueInput"
},
", ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SearchByReferenceInput",
"text": "SearchByReferenceInput"
},
", ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchUnwrapMetaInfo",
"text": "SavedSearchUnwrapMetaInfo"
},
">"
],
"path": "src/plugins/saved_search/public/services/saved_searches/saved_search_attribute_service.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"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": "common",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-common.Reference",
"text": "Reference"
},
"[]; }"
],
"path": "src/plugins/saved_search/public/services/saved_searches/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SearchByReferenceInput",
"type": "Type",
"tags": [],
"label": "SearchByReferenceInput",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
" & SearchBaseInput"
],
"path": "src/plugins/saved_search/public/services/saved_searches/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SearchByValueInput",
"type": "Type",
"tags": [],
"label": "SearchByValueInput",
"description": [],
"signature": [
"{ attributes: ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchByValueAttributes",
"text": "SavedSearchByValueAttributes"
},
"; } & SearchBaseInput"
],
"path": "src/plugins/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/plugins/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(savedSearchId: string) => Promise<",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">"
],
"path": "src/plugins/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/plugins/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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/plugins/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": "common",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-common.SOWithMetadata",
"text": "SOWithMetadata"
},
"<",
"SavedSearchAttributes",
">[]>"
],
"path": "src/plugins/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/plugins/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.save.$1",
"type": "Object",
"tags": [],
"label": "savedSearch",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/plugins/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/plugins/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "savedSearch",
"id": "def-public.SavedSearchPublicPluginStart.byValue",
"type": "Object",
"tags": [],
"label": "byValue",
"description": [],
"signature": [
"{ attributeService: ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchAttributeService",
"text": "SavedSearchAttributeService"
},
"; toSavedSearch: (id: string | undefined, result: ",
{
"pluginId": "savedSearch",
"scope": "public",
"docId": "kibSavedSearchPluginApi",
"section": "def-public.SavedSearchUnwrapResult",
"text": "SavedSearchUnwrapResult"
},
") => Promise<",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">; }"
],
"path": "src/plugins/saved_search/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"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/plugins/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/plugins/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/plugins/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": [
"(id: string | undefined, attributes: ",
"SavedSearchAttributes",
", tags: string[] | undefined, searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
},
") => ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
}
],
"path": "src/plugins/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/plugins/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/plugins/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/plugins/saved_search/common/saved_searches_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.fromSavedSearchAttributes.$4",
"type": "Object",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
}
],
"path": "src/plugins/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: (() => ",
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) | undefined) => Promise<",
"KibanaContextStartDependencies",
">) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ExpressionFunctionKibanaContext",
"text": "ExpressionFunctionKibanaContext"
}
],
"path": "src/plugins/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: (() => ",
{
"pluginId": "@kbn/core-http-server",
"scope": "common",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-common.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) | undefined) => Promise<",
"KibanaContextStartDependencies",
">"
],
"path": "src/plugins/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/plugins/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/plugins/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/plugins/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/plugins/saved_search/common/saved_searches_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "savedSearch",
"id": "def-common.DiscoverGridSettings",
"type": "Interface",
"tags": [],
"label": "DiscoverGridSettings",
"description": [],
"path": "src/plugins/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/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.DiscoverGridSettingsColumn",
"type": "Interface",
"tags": [],
"label": "DiscoverGridSettingsColumn",
"description": [],
"path": "src/plugins/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/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch",
"type": "Interface",
"tags": [],
"label": "SavedSearch",
"description": [],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.searchSource",
"type": "Object",
"tags": [],
"label": "searchSource",
"description": [],
"signature": [
"{ create: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; history: ",
"SearchRequest",
"[]; setField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
">(field: K, value: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; removeField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
">(field: K) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; setFields: (newFields: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; getId: () => string; getFields: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"; getField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
">(field: K, recurse?: boolean) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; getActiveIndexFilter: () => any[]; getOwnField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
">(field: K) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; createCopy: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; createChild: (options?: {}) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; setParent: (parent?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.ISearchSource",
"text": "ISearchSource"
},
" | undefined, options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceOptions",
"text": "SearchSourceOptions"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
"; getParent: () => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
" | undefined; fetch$: <T = {}>(options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => ",
"Observable",
"<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IKibanaSearchResponse",
"text": "IKibanaSearchResponse"
},
"<",
"SearchResponse",
"<T, Record<string, ",
"AggregationsAggregate",
">>>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSource",
"text": "SearchSource"
},
", options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean, includeFields?: boolean) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SerializedSearchSourceFields",
"text": "SerializedSearchSourceFields"
},
"; serialize: () => { searchSourceJSON: string; references: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"; parseActiveIndexPatternFromQueryString: (queryString: string) => string[]; }"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"SortOrder",
"[] | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.grid",
"type": "Object",
"tags": [],
"label": "grid",
"description": [],
"signature": [
"{ columns?: Record<string, ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.DiscoverGridSettingsColumn",
"text": "DiscoverGridSettingsColumn"
},
"> | undefined; } | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.hideChart",
"type": "CompoundType",
"tags": [],
"label": "hideChart",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.viewMode",
"type": "CompoundType",
"tags": [],
"label": "viewMode",
"description": [],
"signature": [
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.VIEW_MODE",
"text": "VIEW_MODE"
},
" | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.hideAggregatedPreview",
"type": "CompoundType",
"tags": [],
"label": "hideAggregatedPreview",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.rowHeight",
"type": "number",
"tags": [],
"label": "rowHeight",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.isTextBasedQuery",
"type": "CompoundType",
"tags": [],
"label": "isTextBasedQuery",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.usesAdHocDataView",
"type": "CompoundType",
"tags": [],
"label": "usesAdHocDataView",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.timeRestore",
"type": "CompoundType",
"tags": [],
"label": "timeRestore",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.refreshInterval",
"type": "Object",
"tags": [],
"label": "refreshInterval",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.rowsPerPage",
"type": "number",
"tags": [],
"label": "rowsPerPage",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.breakdownField",
"type": "string",
"tags": [],
"label": "breakdownField",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
],
"path": "src/plugins/saved_search/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearch.sharingSavedObjectProps",
"type": "Object",
"tags": [],
"label": "sharingSavedObjectProps",
"description": [],
"signature": [
"{ outcome?: \"conflict\" | \"exactMatch\" | \"aliasMatch\" | undefined; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; errorJSON?: string | undefined; } | undefined"
],
"path": "src/plugins/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/plugins/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/plugins/saved_search/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "savedSearch",
"id": "def-common.SavedSearchType",
"type": "string",
"tags": [],
"label": "SavedSearchType",
"description": [],
"signature": [
"\"search\""
],
"path": "src/plugins/saved_search/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}