{ "id": "data.search", "client": { "classes": [], "functions": [ { "parentPluginId": "data", "id": "def-public.isEsError", "type": "Function", "tags": [], "label": "isEsError", "description": [ "\nChecks if a given errors originated from Elasticsearch.\nThose params are assigned to the attributes property of an error.\n" ], "signature": [ "(e: any) => boolean" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.isEsError.$1", "type": "Any", "tags": [], "label": "e", "description": [], "signature": [ "any" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.waitUntilNextSessionCompletes$", "type": "Function", "tags": [], "label": "waitUntilNextSessionCompletes$", "description": [ "\nCreates an observable that emits when next search session completes.\nThis utility is helpful to use in the application to delay some tasks until next session completes.\n" ], "signature": [ "(sessionService: Pick<", "SessionService", ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"continue\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">, { waitForIdle = 1000 }: ", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.WaitUntilNextSessionCompletesOptions", "text": "WaitUntilNextSessionCompletesOptions" }, ") => ", "Observable", "<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionState", "text": "SearchSessionState" }, ">" ], "path": "src/plugins/data/public/search/session/session_helpers.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.waitUntilNextSessionCompletes$.$1", "type": "Object", "tags": [], "label": "sessionService", "description": [ "- {@link ISessionService}" ], "signature": [ "Pick<", "SessionService", ", \"start\" | \"destroy\" | \"state$\" | \"sessionMeta$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"continue\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">" ], "path": "src/plugins/data/public/search/session/session_helpers.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-public.waitUntilNextSessionCompletes$.$2", "type": "Object", "tags": [], "label": "{ waitForIdle = 1000 }", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.WaitUntilNextSessionCompletesOptions", "text": "WaitUntilNextSessionCompletesOptions" } ], "path": "src/plugins/data/public/search/session/session_helpers.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "data", "id": "def-public.ISearchSetup", "type": "Interface", "tags": [], "label": "ISearchSetup", "description": [ "\nThe setup contract exposed by the Search plugin exposes the search strategy extension\npoint." ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.ISearchSetup.aggs", "type": "Object", "tags": [], "label": "aggs", "description": [], "signature": [ "AggsCommonSetup" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.ISearchSetup.usageCollector", "type": "Object", "tags": [], "label": "usageCollector", "description": [], "signature": [ "SearchUsageCollector", " | undefined" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.ISearchSetup.session", "type": "Object", "tags": [], "label": "session", "description": [ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ "{ start: () => string; destroy: () => void; readonly state$: ", "Observable", "<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionState", "text": "SearchSessionState" }, ">; readonly sessionMeta$: ", "Observable", "<", "SessionMeta", ">; hasAccess: () => boolean; trackSearch: (searchDescriptor: ", "TrackSearchDescriptor", ") => () => void; getSessionId: () => string | undefined; getSession$: () => ", "Observable", "; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage:

(searchSessionInfoProvider: ", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionInfoProvider", "text": "SearchSessionInfoProvider" }, "

, searchSessionIndicatorUiConfig?: ", "SearchSessionIndicatorUiConfig", " | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ", "SearchSessionIndicatorUiConfig", "; }" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.ISearchSetup.sessionsClient", "type": "Object", "tags": [], "label": "sessionsClient", "description": [ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "signature": [ "{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record; restoreState: Record; sessionId: string; }) => Promise<", "SearchSessionSavedObject", ">; delete: (sessionId: string) => Promise; find: (options: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, ">; get: (sessionId: string) => Promise<", "SearchSessionSavedObject", ">; update: (sessionId: string, attributes: unknown) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionSavedObjectAttributes", "text": "SearchSessionSavedObjectAttributes" }, ">>; rename: (sessionId: string, newName: string) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, ">>; extend: (sessionId: string, expires: string) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionSavedObjectAttributes", "text": "SearchSessionSavedObjectAttributes" }, ", unknown>>; }" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.ISearchStart", "type": "Interface", "tags": [], "label": "ISearchStart", "description": [ "\nsearch service" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.ISearchStart.aggs", "type": "Object", "tags": [], "label": "aggs", "description": [ "\nagg config sub service\n{@link AggsStart}\n" ], "signature": [ "{ calculateAutoTimeExpression: (range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => string | undefined; datatableUtilities: { getIndexPattern: (column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined>; getAggConfig: (column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined>; isFilterable: (column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => boolean; }; createAggConfigs: (indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, ", configStates?: Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"id\" | \"enabled\" | \"schema\" | \"params\">[] | undefined) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, "; types: ", "AggTypesRegistryStart", "; }" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.ISearchStart.search", "type": "Function", "tags": [], "label": "search", "description": [ "\nlow level search\n{@link ISearchGeneric}" ], "signature": [ " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchRequest", "text": "IEsSearchRequest" }, ", SearchStrategyResponse extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => ", "Observable", "" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-public.ISearchStart.search.$1", "type": "Uncategorized", "tags": [], "label": "request", "description": [], "signature": [ "SearchStrategyRequest" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.ISearchStart.search.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-public.ISearchStart.showError", "type": "Function", "tags": [], "label": "showError", "description": [], "signature": [ "(e: Error) => void" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.ISearchStart.showError.$1", "type": "Object", "tags": [], "label": "e", "description": [], "signature": [ "Error" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.ISearchStart.searchSource", "type": "Object", "tags": [], "label": "searchSource", "description": [ "\nhigh level search\n{@link ISearchStartSearchSource}" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchStartSearchSource", "text": "ISearchStartSearchSource" } ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.ISearchStart.session", "type": "Object", "tags": [], "label": "session", "description": [ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ "{ start: () => string; destroy: () => void; readonly state$: ", "Observable", "<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionState", "text": "SearchSessionState" }, ">; readonly sessionMeta$: ", "Observable", "<", "SessionMeta", ">; hasAccess: () => boolean; trackSearch: (searchDescriptor: ", "TrackSearchDescriptor", ") => () => void; getSessionId: () => string | undefined; getSession$: () => ", "Observable", "; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage:

(searchSessionInfoProvider: ", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionInfoProvider", "text": "SearchSessionInfoProvider" }, "

, searchSessionIndicatorUiConfig?: ", "SearchSessionIndicatorUiConfig", " | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ", "SearchSessionIndicatorUiConfig", "; }" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.ISearchStart.sessionsClient", "type": "Object", "tags": [], "label": "sessionsClient", "description": [ "\nSearch sessions SO CRUD\n{@link ISessionsClient}" ], "signature": [ "{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record; restoreState: Record; sessionId: string; }) => Promise<", "SearchSessionSavedObject", ">; delete: (sessionId: string) => Promise; find: (options: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, ">; get: (sessionId: string) => Promise<", "SearchSessionSavedObject", ">; update: (sessionId: string, attributes: unknown) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionSavedObjectAttributes", "text": "SearchSessionSavedObjectAttributes" }, ">>; rename: (sessionId: string, newName: string) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, ">>; extend: (sessionId: string, expires: string) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionSavedObjectAttributes", "text": "SearchSessionSavedObjectAttributes" }, ", unknown>>; }" ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.Reason", "type": "Interface", "tags": [], "label": "Reason", "description": [], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.Reason.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.Reason.reason", "type": "string", "tags": [], "label": "reason", "description": [], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.Reason.script_stack", "type": "Array", "tags": [], "label": "script_stack", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.Reason.position", "type": "Object", "tags": [], "label": "position", "description": [], "signature": [ "{ offset: number; start: number; end: number; } | undefined" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.Reason.lang", "type": "CompoundType", "tags": [], "label": "lang", "description": [], "signature": [ "\"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.Reason.script", "type": "string", "tags": [], "label": "script", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.Reason.caused_by", "type": "Object", "tags": [], "label": "caused_by", "description": [], "signature": [ "{ type: string; reason: string; } | undefined" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider", "type": "Interface", "tags": [], "label": "SearchSessionInfoProvider", "description": [ "\nProvide info about current search session to be stored in the Search Session saved object" ], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionInfoProvider", "text": "SearchSessionInfoProvider" }, "

" ], "path": "src/plugins/data/public/search/session/session_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider.getName", "type": "Function", "tags": [], "label": "getName", "description": [ "\nUser-facing name of the session.\ne.g. will be displayed in saved Search Sessions management list" ], "signature": [ "() => Promise" ], "path": "src/plugins/data/public/search/session/session_service.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider.appendSessionStartTimeToName", "type": "CompoundType", "tags": [], "label": "appendSessionStartTimeToName", "description": [ "\nAppend session start time to a session name,\n`true` by default" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/public/search/session/session_service.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-public.SearchSessionInfoProvider.getLocatorData", "type": "Function", "tags": [], "label": "getLocatorData", "description": [], "signature": [ "() => Promise<{ id: string; initialState: P; restoreState: P; }>" ], "path": "src/plugins/data/public/search/session/session_service.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.WaitUntilNextSessionCompletesOptions", "type": "Interface", "tags": [], "label": "WaitUntilNextSessionCompletesOptions", "description": [ "\nOptions for {@link waitUntilNextSessionCompletes$}" ], "path": "src/plugins/data/public/search/session/session_helpers.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-public.WaitUntilNextSessionCompletesOptions.waitForIdle", "type": "number", "tags": [], "label": "waitForIdle", "description": [ "\nFor how long to wait between session state transitions before considering that session completed" ], "signature": [ "number | undefined" ], "path": "src/plugins/data/public/search/session/session_helpers.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "data", "id": "def-public.SearchSessionState", "type": "Enum", "tags": [], "label": "SearchSessionState", "description": [ "\nPossible state that current session can be in\n" ], "path": "src/plugins/data/public/search/session/search_session_state.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "data", "id": "def-public.IEsError", "type": "Type", "tags": [], "label": "IEsError", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.KibanaServerError", "text": "KibanaServerError" }, "<", "IEsErrorAttributes", ">" ], "path": "src/plugins/data/public/search/errors/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.ISessionsClient", "type": "Type", "tags": [], "label": "ISessionsClient", "description": [], "signature": [ "{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record; restoreState: Record; sessionId: string; }) => Promise<", "SearchSessionSavedObject", ">; delete: (sessionId: string) => Promise; find: (options: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, ">; get: (sessionId: string) => Promise<", "SearchSessionSavedObject", ">; update: (sessionId: string, attributes: unknown) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionSavedObjectAttributes", "text": "SearchSessionSavedObjectAttributes" }, ">>; rename: (sessionId: string, newName: string) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, ">>; extend: (sessionId: string, expires: string) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionSavedObjectAttributes", "text": "SearchSessionSavedObjectAttributes" }, ", unknown>>; }" ], "path": "src/plugins/data/public/search/session/sessions_client.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.ISessionService", "type": "Type", "tags": [], "label": "ISessionService", "description": [], "signature": [ "{ start: () => string; destroy: () => void; readonly state$: ", "Observable", "<", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionState", "text": "SearchSessionState" }, ">; readonly sessionMeta$: ", "Observable", "<", "SessionMeta", ">; hasAccess: () => boolean; trackSearch: (searchDescriptor: ", "TrackSearchDescriptor", ") => () => void; getSessionId: () => string | undefined; getSession$: () => ", "Observable", "; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; renameCurrentSession: (newName: string) => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage:

(searchSessionInfoProvider: ", { "pluginId": "data", "scope": "public", "docId": "kibDataSearchPluginApi", "section": "def-public.SearchSessionInfoProvider", "text": "SearchSessionInfoProvider" }, "

, searchSessionIndicatorUiConfig?: ", "SearchSessionIndicatorUiConfig", " | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ", "SearchSessionIndicatorUiConfig", "; }" ], "path": "src/plugins/data/public/search/session/session_service.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.noSearchSessionStorageCapabilityMessage", "type": "string", "tags": [], "label": "noSearchSessionStorageCapabilityMessage", "description": [ "\nMessage to display in case storing\nsession session is disabled due to turned off capability" ], "path": "src/plugins/data/public/search/session/i18n.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-public.SEARCH_SESSIONS_MANAGEMENT_ID", "type": "string", "tags": [], "label": "SEARCH_SESSIONS_MANAGEMENT_ID", "description": [], "signature": [ "\"search_sessions\"" ], "path": "src/plugins/data/public/search/session/constants.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [] }, "server": { "classes": [ { "parentPluginId": "data", "id": "def-server.NoSearchIdInSessionError", "type": "Class", "tags": [], "label": "NoSearchIdInSessionError", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.NoSearchIdInSessionError", "text": "NoSearchIdInSessionError" }, " extends ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.KbnError", "text": "KbnError" } ], "path": "src/plugins/data/server/search/errors/no_search_id_in_session.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.NoSearchIdInSessionError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/server/search/errors/no_search_id_in_session.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [], "interfaces": [ { "parentPluginId": "data", "id": "def-server.AsyncSearchStatusResponse", "type": "Interface", "tags": [], "label": "AsyncSearchStatusResponse", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.AsyncSearchStatusResponse", "text": "AsyncSearchStatusResponse" }, " extends Pick<", "AsyncSearchResponse", ", \"id\" | \"start_time_in_millis\" | \"expiration_time_in_millis\" | \"is_partial\" | \"is_running\">" ], "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.AsyncSearchStatusResponse.completion_status", "type": "number", "tags": [], "label": "completion_status", "description": [], "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.AsyncSearchStatusResponse._shards", "type": "Object", "tags": [], "label": "_shards", "description": [], "signature": [ "ShardStatistics" ], "path": "src/plugins/data/server/search/strategies/ese_search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient", "type": "Interface", "tags": [], "label": "IScopedSearchClient", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.IScopedSearchClient", "text": "IScopedSearchClient" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchClient", "text": "ISearchClient" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.saveSession", "type": "Function", "tags": [], "label": "saveSession", "description": [], "signature": [ "(sessionId: string, attributes: Partial) => Promise<", "SavedObject", " | undefined>" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.saveSession.$1", "type": "string", "tags": [], "label": "sessionId", "description": [], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.saveSession.$2", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ "{ [P in keyof T]?: T[P] | undefined; }" ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.getSession", "type": "Function", "tags": [], "label": "getSession", "description": [], "signature": [ "(sessionId: string) => Promise<", "SavedObject", ">" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.getSession.$1", "type": "string", "tags": [], "label": "sessionId", "description": [], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.findSessions", "type": "Function", "tags": [], "label": "findSessions", "description": [], "signature": [ "(options: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, ", \"filter\" | \"aggs\" | \"fields\" | \"searchAfter\" | \"page\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\" | \"pit\">) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, ">" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.findSessions.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "{ filter?: any; aggs?: Record | undefined; fields?: string[] | undefined; searchAfter?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | \"_doc\" | undefined; search?: string | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptionsReference", "text": "SavedObjectsFindOptionsReference" }, "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; pit?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsPitParams", "text": "SavedObjectsPitParams" }, " | undefined; }" ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.updateSession", "type": "Function", "tags": [], "label": "updateSession", "description": [], "signature": [ "(sessionId: string, attributes: Partial) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, ">" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.updateSession.$1", "type": "string", "tags": [], "label": "sessionId", "description": [], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.updateSession.$2", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ "{ [P in keyof T]?: T[P] | undefined; }" ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.cancelSession", "type": "Function", "tags": [], "label": "cancelSession", "description": [], "signature": [ "(sessionId: string) => Promise<{}>" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.cancelSession.$1", "type": "string", "tags": [], "label": "sessionId", "description": [], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.deleteSession", "type": "Function", "tags": [], "label": "deleteSession", "description": [], "signature": [ "(sessionId: string) => Promise<{}>" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.deleteSession.$1", "type": "string", "tags": [], "label": "sessionId", "description": [], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.extendSession", "type": "Function", "tags": [], "label": "extendSession", "description": [], "signature": [ "(sessionId: string, expires: Date) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, ">" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.extendSession.$1", "type": "string", "tags": [], "label": "sessionId", "description": [], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient.extendSession.$2", "type": "Object", "tags": [], "label": "expires", "description": [], "signature": [ "Date" ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-server.ISearchSessionService", "type": "Interface", "tags": [], "label": "ISearchSessionService", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchSessionService", "text": "ISearchSessionService" }, "" ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.ISearchSessionService.asScopedProvider", "type": "Function", "tags": [], "label": "asScopedProvider", "description": [], "signature": [ "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreStart", "text": "CoreStart" }, ") => (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => ", "IScopedSearchSessionsClient", "" ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.ISearchSessionService.asScopedProvider.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.CoreStart", "text": "CoreStart" } ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy", "type": "Interface", "tags": [], "label": "ISearchStrategy", "description": [ "\nSearch strategy interface contains a search method that takes in a request and returns a promise\nthat resolves to a response." ], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.ISearchStrategy", "text": "ISearchStrategy" }, "" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.ISearchStrategy.search", "type": "Function", "tags": [], "label": "search", "description": [], "signature": [ "(request: SearchStrategyRequest, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ", deps: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" }, ") => ", "Observable", "" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.ISearchStrategy.search.$1", "type": "Uncategorized", "tags": [], "label": "request", "description": [], "signature": [ "SearchStrategyRequest" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.search.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.search.$3", "type": "Object", "tags": [], "label": "deps", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [], "signature": [ "((id: string, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ", deps: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" }, ") => Promise) | undefined" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.ISearchStrategy.cancel.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.cancel.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.cancel.$3", "type": "Object", "tags": [], "label": "deps", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.extend", "type": "Function", "tags": [], "label": "extend", "description": [], "signature": [ "((id: string, keepAlive: string, options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ", deps: ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" }, ") => Promise) | undefined" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.ISearchStrategy.extend.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.extend.$2", "type": "string", "tags": [], "label": "keepAlive", "description": [], "signature": [ "string" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.extend.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-server.ISearchStrategy.extend.$4", "type": "Object", "tags": [], "label": "deps", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.SearchStrategyDependencies", "text": "SearchStrategyDependencies" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies", "type": "Interface", "tags": [], "label": "SearchStrategyDependencies", "description": [], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.savedObjectsClient", "type": "Object", "tags": [], "label": "savedObjectsClient", "description": [], "signature": [ "{ create: (type: string, attributes: T, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, " | undefined) => Promise<", "SavedObject", ">; bulkCreate: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkCreateObject", "text": "SavedObjectsBulkCreateObject" }, "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCreateOptions", "text": "SavedObjectsCreateOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkResponse", "text": "SavedObjectsBulkResponse" }, ">; checkConflicts: (objects?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCheckConflictsObject", "text": "SavedObjectsCheckConflictsObject" }, "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCheckConflictsResponse", "text": "SavedObjectsCheckConflictsResponse" }, ">; delete: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsDeleteOptions", "text": "SavedObjectsDeleteOptions" }, ") => Promise<{}>; find: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, ">; bulkGet: (objects?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkGetObject", "text": "SavedObjectsBulkGetObject" }, "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkResponse", "text": "SavedObjectsBulkResponse" }, ">; bulkResolve: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkResolveObject", "text": "SavedObjectsBulkResolveObject" }, "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkResolveResponse", "text": "SavedObjectsBulkResolveResponse" }, ">; get: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, ") => Promise<", "SavedObject", ">; resolve: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsResolveResponse", "text": "SavedObjectsResolveResponse" }, ">; update: (type: string, id: string, attributes: Partial, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateOptions", "text": "SavedObjectsUpdateOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateResponse", "text": "SavedObjectsUpdateResponse" }, ">; collectMultiNamespaceReferences: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", "text": "SavedObjectsCollectMultiNamespaceReferencesObject" }, "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" }, ">; updateObjectsSpaces: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", "text": "SavedObjectsUpdateObjectsSpacesObject" }, "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", "text": "SavedObjectsUpdateObjectsSpacesOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", "text": "SavedObjectsUpdateObjectsSpacesResponse" }, ">; bulkUpdate: (objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkUpdateObject", "text": "SavedObjectsBulkUpdateObject" }, "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkUpdateOptions", "text": "SavedObjectsBulkUpdateOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBulkUpdateResponse", "text": "SavedObjectsBulkUpdateResponse" }, ">; removeReferencesTo: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsRemoveReferencesToOptions", "text": "SavedObjectsRemoveReferencesToOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsRemoveReferencesToResponse", "text": "SavedObjectsRemoveReferencesToResponse" }, ">; openPointInTimeForType: (type: string | string[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsOpenPointInTimeOptions", "text": "SavedObjectsOpenPointInTimeOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsOpenPointInTimeResponse", "text": "SavedObjectsOpenPointInTimeResponse" }, ">; closePointInTime: (id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsClosePointInTimeResponse", "text": "SavedObjectsClosePointInTimeResponse" }, ">; createPointInTimeFinder: (findOptions: Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", "text": "SavedObjectsCreatePointInTimeFinderDependencies" }, " | undefined) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.ISavedObjectsPointInTimeFinder", "text": "ISavedObjectsPointInTimeFinder" }, "; errors: typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsErrorHelpers", "text": "SavedObjectsErrorHelpers" }, "; }" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.esClient", "type": "Object", "tags": [], "label": "esClient", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IScopedClusterClient", "text": "IScopedClusterClient" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.uiSettingsClient", "type": "Object", "tags": [], "label": "uiSettingsClient", "description": [], "signature": [ "{ get: (key: string) => Promise; }" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.searchSessionsClient", "type": "Object", "tags": [], "label": "searchSessionsClient", "description": [], "signature": [ "IScopedSearchSessionsClient", "" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-server.SearchStrategyDependencies.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "data", "id": "def-server.SearchRequestHandlerContext", "type": "Type", "tags": [], "label": "SearchRequestHandlerContext", "description": [], "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", "section": "def-server.IScopedSearchClient", "text": "IScopedSearchClient" } ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [] }, "common": { "classes": [ { "parentPluginId": "data", "id": "def-common.AggConfig", "type": "Class", "tags": [], "label": "AggConfig", "description": [], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.ensureIds", "type": "Function", "tags": [ "return" ], "label": "ensureIds", "description": [ "\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n" ], "signature": [ "(list: any[]) => any[]" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.ensureIds.$1", "type": "Array", "tags": [], "label": "list", "description": [ "- a list of objects, objects can be anything really" ], "signature": [ "any[]" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ "- the list that was passed in" ] }, { "parentPluginId": "data", "id": "def-common.AggConfig.nextId", "type": "Function", "tags": [ "return" ], "label": "nextId", "description": [ "\nCalculate the next id based on the ids in this list\n" ], "signature": [ "(list: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]) => number" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.nextId.$1", "type": "Array", "tags": [], "label": "list", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ "list - a list of objects with id properties" ] }, { "parentPluginId": "data", "id": "def-common.AggConfig.aggConfigs", "type": "Object", "tags": [], "label": "aggConfigs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.enabled", "type": "boolean", "tags": [], "label": "enabled", "description": [], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.params", "type": "Any", "tags": [], "label": "params", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.parent", "type": "Object", "tags": [], "label": "parent", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.brandNew", "type": "CompoundType", "tags": [], "label": "brandNew", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.schema", "type": "string", "tags": [], "label": "schema", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.Unnamed.$1", "type": "Object", "tags": [], "label": "aggConfigs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfig.Unnamed.$2", "type": "Object", "tags": [], "label": "opts", "description": [], "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"id\" | \"enabled\" | \"schema\" | \"params\">" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.setParams", "type": "Function", "tags": [ "return" ], "label": "setParams", "description": [ "\nWrite the current values to this.params, filling in the defaults as we go\n" ], "signature": [ "(from: any) => void" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.setParams.$1", "type": "Any", "tags": [], "label": "from", "description": [ "- optional object to read values from,\n used when initializing" ], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getParam", "type": "Function", "tags": [], "label": "getParam", "description": [], "signature": [ "(key: string) => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.getParam.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.hasTimeShift", "type": "Function", "tags": [], "label": "hasTimeShift", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getTimeShift", "type": "Function", "tags": [], "label": "getTimeShift", "description": [], "signature": [ "() => moment.Duration | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.write", "type": "Function", "tags": [], "label": "write", "description": [], "signature": [ "(aggs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined) => Record" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.write.$1", "type": "Object", "tags": [], "label": "aggs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.isFilterable", "type": "Function", "tags": [], "label": "isFilterable", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.createFilter", "type": "Function", "tags": [], "label": "createFilter", "description": [], "signature": [ "(key: string, params?: {}) => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.createFilter.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfig.createFilter.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{}" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.onSearchRequestStart", "type": "Function", "tags": [ "return" ], "label": "onSearchRequestStart", "description": [ "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" ], "signature": [ "(searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise | Promise" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.onSearchRequestStart.$1", "type": "Object", "tags": [], "label": "searchSource", "description": [], "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfig.onSearchRequestStart.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.toDsl", "type": "Function", "tags": [ "return" ], "label": "toDsl", "description": [ "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" ], "signature": [ "(aggConfigs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined) => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.toDsl.$1", "type": "Object", "tags": [], "label": "aggConfigs", "description": [ "- the config object to convert" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": false } ], "returnComment": [ "- if the config has a dsl representation, it is\n returned, else undefined is returned" ] }, { "parentPluginId": "data", "id": "def-common.AggConfig.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [], "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [ "Returns a serialized representation of an AggConfig." ] }, { "parentPluginId": "data", "id": "def-common.AggConfig.toJSON", "type": "Function", "tags": [ "deprecated" ], "label": "toJSON", "description": [], "signature": [ "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": true, "removeBy": "8.1", "references": [ { "plugin": "visualizations", "path": "src/plugins/visualizations/public/vis.ts" }, { "plugin": "visDefaultEditor", "path": "src/plugins/vis_default_editor/public/components/sidebar/state/reducers.ts" }, { "plugin": "visDefaultEditor", "path": "src/plugins/vis_default_editor/public/components/sidebar/state/reducers.ts" }, { "plugin": "visDefaultEditor", "path": "src/plugins/vis_default_editor/public/components/sidebar/state/reducers.ts" }, { "plugin": "visDefaultEditor", "path": "src/plugins/vis_default_editor/public/components/sidebar/sidebar.tsx" } ], "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.toSerializedFieldFormat", "type": "Function", "tags": [], "label": "toSerializedFieldFormat", "description": [ "\nReturns a serialized field format for the field used in this agg.\nThis can be passed to fieldFormats.deserialize to get the field\nformat instance.\n" ], "signature": [ "() => {}" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.toExpressionAst", "type": "Function", "tags": [], "label": "toExpressionAst", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [ "Returns an ExpressionAst representing the this agg type." ] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getAggParams", "type": "Function", "tags": [], "label": "getAggParams", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">[]" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getRequestAggs", "type": "Function", "tags": [], "label": "getRequestAggs", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getResponseAggs", "type": "Function", "tags": [], "label": "getResponseAggs", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getValue", "type": "Function", "tags": [], "label": "getValue", "description": [], "signature": [ "(bucket: any) => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.getValue.$1", "type": "Any", "tags": [], "label": "bucket", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getKey", "type": "Function", "tags": [], "label": "getKey", "description": [], "signature": [ "(bucket: any, key?: string | undefined) => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.getKey.$1", "type": "Any", "tags": [], "label": "bucket", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfig.getKey.$2", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getFieldDisplayName", "type": "Function", "tags": [], "label": "getFieldDisplayName", "description": [], "signature": [ "() => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getField", "type": "Function", "tags": [], "label": "getField", "description": [], "signature": [ "() => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getValueBucketPath", "type": "Function", "tags": [], "label": "getValueBucketPath", "description": [ "\nReturns the bucket path containing the main value the agg will produce\n(e.g. for sum of bytes it will point to the sum, for median it will point\n to the 50 percentile in the percentile multi value bucket)" ], "signature": [ "() => string" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.makeLabel", "type": "Function", "tags": [], "label": "makeLabel", "description": [], "signature": [ "(percentageMode?: boolean) => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.makeLabel.$1", "type": "boolean", "tags": [], "label": "percentageMode", "description": [], "signature": [ "boolean" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getIndexPattern", "type": "Function", "tags": [], "label": "getIndexPattern", "description": [], "signature": [ "() => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.getTimeRange", "type": "Function", "tags": [], "label": "getTimeRange", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.fieldName", "type": "Function", "tags": [], "label": "fieldName", "description": [], "signature": [ "() => any" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.fieldIsTimeField", "type": "Function", "tags": [], "label": "fieldIsTimeField", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfig.type", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">>" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.type", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">>" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfig.setType", "type": "Function", "tags": [], "label": "setType", "description": [], "signature": [ "(type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, ") => void" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfig.setType.$1", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" } ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggConfigs", "type": "Class", "tags": [], "label": "AggConfigs", "description": [], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.indexPattern", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfigs.timeRange", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfigs.timeFields", "type": "Array", "tags": [], "label": "timeFields", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfigs.forceNow", "type": "Object", "tags": [], "label": "forceNow", "description": [], "signature": [ "Date | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfigs.hierarchical", "type": "CompoundType", "tags": [], "label": "hierarchical", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfigs.aggs", "type": "Array", "tags": [], "label": "aggs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed.$1", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed.$2", "type": "Array", "tags": [], "label": "configStates", "description": [], "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"id\" | \"enabled\" | \"schema\" | \"params\">[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfigs.Unnamed.$3", "type": "Object", "tags": [], "label": "opts", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigsOptions", "text": "AggConfigsOptions" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeFields", "type": "Function", "tags": [], "label": "setTimeFields", "description": [], "signature": [ "(timeFields: string[] | undefined) => void" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeFields.$1", "type": "Array", "tags": [], "label": "timeFields", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.setForceNow", "type": "Function", "tags": [], "label": "setForceNow", "description": [], "signature": [ "(now: Date | undefined) => void" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.setForceNow.$1", "type": "Object", "tags": [], "label": "now", "description": [], "signature": [ "Date | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeRange", "type": "Function", "tags": [], "label": "setTimeRange", "description": [], "signature": [ "(timeRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => void" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.setTimeRange.$1", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getResolvedTimeRange", "type": "Function", "tags": [], "label": "getResolvedTimeRange", "description": [ "\nReturns the current time range as moment instance (date math will get resolved using the current \"now\" value or system time if not set)" ], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRangeBounds", "text": "TimeRangeBounds" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [ "Current time range as resolved date." ] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.clone", "type": "Function", "tags": [], "label": "clone", "description": [], "signature": [ "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.clone.$1", "type": "Object", "tags": [], "label": "{ enabledOnly = true }", "description": [], "signature": [ "{ enabledOnly?: boolean | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.createAggConfig", "type": "Function", "tags": [], "label": "createAggConfig", "description": [], "signature": [ "(params: Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"id\" | \"enabled\" | \"schema\" | \"params\">, { addToAggConfigs }?: { addToAggConfigs?: boolean | undefined; }) => T" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.createAggConfig.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"id\" | \"enabled\" | \"schema\" | \"params\">" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfigs.createAggConfig.$2", "type": "Object", "tags": [], "label": "{ addToAggConfigs = true }", "description": [], "signature": [ "{ addToAggConfigs?: boolean | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.jsonDataEquals", "type": "Function", "tags": [], "label": "jsonDataEquals", "description": [ "\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes" ], "signature": [ "(aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]) => boolean" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.jsonDataEquals.$1", "type": "Array", "tags": [], "label": "aggConfigs", "description": [ "an AggConfigs instance" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.toDsl", "type": "Function", "tags": [], "label": "toDsl", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getAll", "type": "Function", "tags": [], "label": "getAll", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.byIndex", "type": "Function", "tags": [], "label": "byIndex", "description": [], "signature": [ "(index: number) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.byIndex.$1", "type": "number", "tags": [], "label": "index", "description": [], "signature": [ "number" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.byId", "type": "Function", "tags": [], "label": "byId", "description": [], "signature": [ "(id: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.byId.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.byName", "type": "Function", "tags": [], "label": "byName", "description": [], "signature": [ "(name: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.byName.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.byType", "type": "Function", "tags": [], "label": "byType", "description": [], "signature": [ "(type: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.byType.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.byTypeName", "type": "Function", "tags": [], "label": "byTypeName", "description": [], "signature": [ "(type: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.byTypeName.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.bySchemaName", "type": "Function", "tags": [], "label": "bySchemaName", "description": [], "signature": [ "(schema: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.bySchemaName.$1", "type": "string", "tags": [], "label": "schema", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggs", "type": "Function", "tags": [], "label": "getRequestAggs", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getTimeShifts", "type": "Function", "tags": [], "label": "getTimeShifts", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getTimeShiftInterval", "type": "Function", "tags": [], "label": "getTimeShiftInterval", "description": [], "signature": [ "() => moment.Duration | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.hasTimeShifts", "type": "Function", "tags": [], "label": "hasTimeShifts", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getSearchSourceTimeFilter", "type": "Function", "tags": [], "label": "getSearchSourceTimeFilter", "description": [], "signature": [ "(forceNow?: Date | undefined) => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.RangeFilter", "text": "RangeFilter" }, "[] | { meta: { index: string | undefined; params: {}; alias: string; disabled: boolean; negate: boolean; }; query: { bool: { should: { bool: { filter: { range: { [x: string]: { gte: string; lte: string; }; }; }[]; }; }[]; minimum_should_match: number; }; }; }[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.getSearchSourceTimeFilter.$1", "type": "Object", "tags": [], "label": "forceNow", "description": [], "signature": [ "Date | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.postFlightTransform", "type": "Function", "tags": [], "label": "postFlightTransform", "description": [], "signature": [ "(response: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, "" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.postFlightTransform.$1", "type": "Object", "tags": [], "label": "response", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, "" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggById", "type": "Function", "tags": [], "label": "getRequestAggById", "description": [], "signature": [ "(id: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.getRequestAggById.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getResponseAggs", "type": "Function", "tags": [ "return" ], "label": "getResponseAggs", "description": [ "\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n" ], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.getResponseAggById", "type": "Function", "tags": [ "return" ], "label": "getResponseAggById", "description": [ "\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n" ], "signature": [ "(id: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.getResponseAggById.$1", "type": "string", "tags": [], "label": "id", "description": [ "- the id of the agg to find" ], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart", "type": "Function", "tags": [], "label": "onSearchRequestStart", "description": [], "signature": [ "(searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart.$1", "type": "Object", "tags": [], "label": "searchSource", "description": [], "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggConfigs.onSearchRequestStart.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamType", "type": "Class", "tags": [], "label": "AggParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "" ], "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamType.makeAgg", "type": "Function", "tags": [], "label": "makeAgg", "description": [], "signature": [ "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" ], "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.AggParamType.makeAgg.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamType.makeAgg.$2", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.AggParamType.allowedAggs", "type": "Array", "tags": [], "label": "allowedAggs", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggsCommonService", "type": "Class", "tags": [], "label": "AggsCommonService", "description": [ "\nThe aggs service provides a means of modeling and manipulating the various\nElasticsearch aggregations supported by Kibana, providing the ability to\noutput the correct DSL when you are ready to send your request to ES." ], "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggsCommonService.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "({ registerFunction }: ", "AggsCommonSetupDependencies", ") => ", "AggsCommonSetup" ], "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggsCommonService.setup.$1", "type": "Object", "tags": [], "label": "{ registerFunction }", "description": [], "signature": [ "AggsCommonSetupDependencies" ], "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggsCommonService.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "({ getConfig, getIndexPattern, isDefaultTimezone, }: ", "AggsCommonStartDependencies", ") => ", "AggsCommonStart" ], "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggsCommonService.start.$1", "type": "Object", "tags": [], "label": "{\n getConfig,\n getIndexPattern,\n isDefaultTimezone,\n }", "description": [], "signature": [ "AggsCommonStartDependencies" ], "path": "src/plugins/data/common/search/aggs/aggs_service.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggType", "type": "Class", "tags": [], "label": "AggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, "" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggType.name", "type": "string", "tags": [ "property", "type" ], "label": "name", "description": [ "\nthe unique, unchanging, name that we have assigned this aggType\n" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.subtype", "type": "string", "tags": [], "label": "subtype", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.dslName", "type": "string", "tags": [ "property", "type" ], "label": "dslName", "description": [ "\nthe name of the elasticsearch aggregation that this aggType represents. Usually just this.name\n" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.expressionName", "type": "string", "tags": [ "property", "type" ], "label": "expressionName", "description": [ "\nthe name of the expression function that this aggType represents.\n" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.title", "type": "string", "tags": [ "property", "type" ], "label": "title", "description": [ "\nthe user friendly name that will be shown in the ui for this aggType\n" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.valueType", "type": "CompoundType", "tags": [], "label": "valueType", "description": [ "\nThe type the values produced by this agg will have in the final data table.\nIf not specified, the type of the field is used." ], "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.makeLabel", "type": "Function", "tags": [ "method" ], "label": "makeLabel", "description": [ "\na function that will be called when this aggType is assigned to\nan aggConfig, and that aggConfig is being rendered (in a form, chart, etc.).\n" ], "signature": [ "((aggConfig: TAggConfig) => string) | (() => string)" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "returnComment": [ "- label that can be used in the ui to describe the aggConfig" ], "children": [ { "parentPluginId": "data", "id": "def-common.AggType.makeLabel.$1", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [ "- an agg config of this type" ], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.AggType.ordered", "type": "Any", "tags": [ "property", "type" ], "label": "ordered", "description": [ "\nDescribes if this aggType creates data that is ordered, and if that ordered data\nis some sort of time series.\n\nIf the aggType does not create ordered data, set this to something \"falsy\".\n\nIf this does create orderedData, then the value should be an object.\n\nIf the orderdata is some sort of time series, `this.ordered` should be an object\nwith the property `date: true`\n" ], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.hasNoDsl", "type": "boolean", "tags": [ "type" ], "label": "hasNoDsl", "description": [ "\nFlag that prevents this aggregation from being included in the dsl. This is only\nused by the count aggregation (currently) since it doesn't really exist and it's output\nis available on every bucket.\n" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.hasNoDslParams", "type": "boolean", "tags": [ "type" ], "label": "hasNoDslParams", "description": [ "\nFlag that prevents params from this aggregation from being included in the dsl. Sibling and parent aggs are still written.\n" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.createFilter", "type": "Function", "tags": [], "label": "createFilter", "description": [ "\nThe method to create a filter representation of the bucket" ], "signature": [ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.params", "type": "Array", "tags": [ "property", "type" ], "label": "params", "description": [ "\nAn instance of {{#crossLink \"AggParams\"}}{{/crossLink}}.\n" ], "signature": [ "TParam[]" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.getRequestAggs", "type": "Function", "tags": [ "method" ], "label": "getRequestAggs", "description": [ "\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in requests\n" ], "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "returnComment": [ "- an array of aggConfig objects\n that should replace this one,\n or undefined" ], "children": [ { "parentPluginId": "data", "id": "def-common.AggType.getRequestAggs.$1", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.AggType.getResponseAggs", "type": "Function", "tags": [ "method" ], "label": "getResponseAggs", "description": [ "\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in result sets\nthat walk the AggConfig set.\n" ], "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "returnComment": [ "- an array of aggConfig objects\n that should replace this one,\n or undefined" ], "children": [ { "parentPluginId": "data", "id": "def-common.AggType.getResponseAggs.$1", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.AggType.decorateAggConfig", "type": "Function", "tags": [], "label": "decorateAggConfig", "description": [ "\nA function that will be called each time an aggConfig of this type\nis created, giving the agg type a chance to modify the agg config" ], "signature": [ "() => any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest", "type": "Function", "tags": [ "return" ], "label": "postFlightRequest", "description": [ "\nA function that needs to be called after the main request has been made\nand should return an updated response" ], "signature": [ "(resp: ", "SearchResponse", ", aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, ", aggConfig: TAggConfig, searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise<", "SearchResponse", ">" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest.$1", "type": "Object", "tags": [], "label": "resp", "description": [ "- Response to the main request" ], "signature": [ "SearchResponse", "" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest.$2", "type": "Object", "tags": [], "label": "aggConfigs", "description": [ "- agg config array used to produce main request" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest.$3", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [ "- AggConfig that requested the post flight request" ], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest.$4", "type": "Object", "tags": [], "label": "searchSource", "description": [], "signature": [ "{ create: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (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" }, "; removeField: (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: (field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]; getOwnField: (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?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | 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$: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", "SearchResponse", ">>; fetch: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => Promise<", "SearchResponse", ">; 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.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "; serialize: () => { searchSourceJSON: string; references: ", "SavedObjectReference", "[]; }; }" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest.$5", "type": "Object", "tags": [], "label": "inspectorRequestAdapter", "description": [], "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest.$6", "type": "Object", "tags": [], "label": "abortSignal", "description": [ "- `AbortSignal` to abort the request" ], "signature": [ "AbortSignal | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.postFlightRequest.$7", "type": "string", "tags": [], "label": "searchSessionId", "description": [ "- searchSessionId to be used for grouping requests into a single search session" ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.AggType.getSerializedFormat", "type": "Function", "tags": [ "return" ], "label": "getSerializedFormat", "description": [ "\nGet the serialized format for the values produced by this agg type,\noverridden by several metrics that always output a simple number.\nYou can pass this output to fieldFormatters.deserialize to get\nthe formatter instance.\n" ], "signature": [ "(agg: TAggConfig) => ", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", "section": "def-common.SerializedFieldFormat", "text": "SerializedFieldFormat" }, "<", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", "section": "def-common.FieldFormatParams", "text": "FieldFormatParams" }, ">" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.AggType.getSerializedFormat.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [ "- the agg to pick a format for" ], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.AggType.getValue", "type": "Function", "tags": [], "label": "getValue", "description": [], "signature": [ "(agg: TAggConfig, bucket: any) => any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.AggType.getValue.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.getValue.$2", "type": "Any", "tags": [], "label": "bucket", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.AggType.getKey", "type": "Function", "tags": [], "label": "getKey", "description": [], "signature": [ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggType.paramByName", "type": "Function", "tags": [], "label": "paramByName", "description": [], "signature": [ "(name: string) => TParam | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggType.paramByName.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggType.getValueBucketPath", "type": "Function", "tags": [], "label": "getValueBucketPath", "description": [], "signature": [ "(agg: TAggConfig) => string" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggType.getValueBucketPath.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggType.splitForTimeShift", "type": "Function", "tags": [], "label": "splitForTimeShift", "description": [], "signature": [ "(agg: TAggConfig, aggs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, ") => boolean" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggType.splitForTimeShift.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggType.splitForTimeShift.$2", "type": "Object", "tags": [], "label": "aggs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggType.Unnamed", "type": "Function", "tags": [ "class", "private" ], "label": "Constructor", "description": [ "\nGeneric AggType Constructor\n\nUsed to create the values exposed by the agg_types module.\n" ], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [ "- used to set the properties of the AggType" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggTypeConfig", "text": "AggTypeConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggTypesRegistry", "type": "Class", "tags": [], "label": "AggTypesRegistry", "description": [], "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggTypesRegistry.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "() => { registerBucket: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, ">(name: N, type: T) => void; registerMetric: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, ">(name: N, type: T) => void; }" ], "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggTypesRegistry.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "() => { get: (name: string) => any; getAll: () => { buckets: any[]; metrics: any[]; }; }" ], "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType", "type": "Class", "tags": [], "label": "BaseParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BaseParamType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.displayName", "type": "string", "tags": [], "label": "displayName", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.required", "type": "boolean", "tags": [], "label": "required", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.advanced", "type": "boolean", "tags": [], "label": "advanced", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.default", "type": "Any", "tags": [], "label": "default", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.write", "type": "Function", "tags": [], "label": "write", "description": [], "signature": [ "(aggConfig: TAggConfig, output: Record, aggConfigs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined, locals?: Record | undefined) => void" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.BaseParamType.write.$1", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.write.$2", "type": "Object", "tags": [], "label": "output", "description": [], "signature": [ "{ [x: string]: any; }" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.write.$3", "type": "Object", "tags": [], "label": "aggConfigs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.write.$4", "type": "Object", "tags": [], "label": "locals", "description": [], "signature": [ "Record | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.BaseParamType.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [], "signature": [ "(value: any, aggConfig?: TAggConfig | undefined) => any" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.BaseParamType.serialize.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.serialize.$2", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [], "signature": [ "TAggConfig | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.BaseParamType.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "(value: any, aggConfig?: TAggConfig | undefined) => any" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.BaseParamType.deserialize.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.deserialize.$2", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [], "signature": [ "TAggConfig | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.BaseParamType.toExpressionAst", "type": "Function", "tags": [], "label": "toExpressionAst", "description": [], "signature": [ "((value: any) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[] | undefined) | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "any[]" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.valueType", "type": "Any", "tags": [], "label": "valueType", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.modifyAggConfigOnSearchRequestStart", "type": "Function", "tags": [], "label": "modifyAggConfigOnSearchRequestStart", "description": [ "\n A function that will be called before an aggConfig is serialized and sent to ES.\n Allows aggConfig to retrieve values needed for serialization\n Example usage: an aggregation needs to know the min/max of a field to determine an appropriate interval\n" ], "signature": [ "(aggConfig: TAggConfig, searchSource?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => void" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.BaseParamType.modifyAggConfigOnSearchRequestStart.$1", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.modifyAggConfigOnSearchRequestStart.$2", "type": "Object", "tags": [], "label": "searchSource", "description": [], "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BaseParamType.modifyAggConfigOnSearchRequestStart.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.BaseParamType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BaseParamType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/aggs/param_types/base.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.BucketAggType", "type": "Class", "tags": [], "label": "BucketAggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BucketAggType.getKey", "type": "Function", "tags": [], "label": "getKey", "description": [], "signature": [ "(bucket: any, key: any, agg: TBucketAggConfig) => any" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.BucketAggType.getKey.$1", "type": "Any", "tags": [], "label": "bucket", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BucketAggType.getKey.$2", "type": "Any", "tags": [], "label": "key", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BucketAggType.getKey.$3", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TBucketAggConfig" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.BucketAggType.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BucketAggType.getShiftedKey", "type": "Function", "tags": [], "label": "getShiftedKey", "description": [], "signature": [ "(agg: TBucketAggConfig, key: React.ReactText, timeShift: moment.Duration) => React.ReactText" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BucketAggType.getShiftedKey.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TBucketAggConfig" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.BucketAggType.getShiftedKey.$2", "type": "CompoundType", "tags": [], "label": "key", "description": [], "signature": [ "React.ReactText" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.BucketAggType.getShiftedKey.$3", "type": "Object", "tags": [], "label": "timeShift", "description": [], "signature": [ "moment.Duration" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.BucketAggType.getTimeShiftInterval", "type": "Function", "tags": [], "label": "getTimeShiftInterval", "description": [], "signature": [ "(agg: TBucketAggConfig) => moment.Duration | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BucketAggType.getTimeShiftInterval.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TBucketAggConfig" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.BucketAggType.orderBuckets", "type": "Function", "tags": [], "label": "orderBuckets", "description": [], "signature": [ "(agg: TBucketAggConfig, a: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GenericBucket", "text": "GenericBucket" }, ", b: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GenericBucket", "text": "GenericBucket" }, ") => number" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BucketAggType.orderBuckets.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TBucketAggConfig" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.BucketAggType.orderBuckets.$2", "type": "CompoundType", "tags": [], "label": "a", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GenericBucket", "text": "GenericBucket" } ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.BucketAggType.orderBuckets.$3", "type": "CompoundType", "tags": [], "label": "b", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GenericBucket", "text": "GenericBucket" } ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.BucketAggType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BucketAggType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "BucketAggTypeConfig" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.CidrMask", "type": "Class", "tags": [], "label": "CidrMask", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.CidrMask.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.CidrMask.Unnamed.$1", "type": "string", "tags": [], "label": "cidr", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.CidrMask.getRange", "type": "Function", "tags": [], "label": "getRange", "description": [], "signature": [ "() => { from: string; to: string; }" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.CidrMask.toString", "type": "Function", "tags": [], "label": "toString", "description": [], "signature": [ "() => string" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.FieldParamType", "type": "Class", "tags": [], "label": "FieldParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FieldParamType", "text": "FieldParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.FieldParamType.required", "type": "boolean", "tags": [], "label": "required", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.FieldParamType.scriptable", "type": "boolean", "tags": [], "label": "scriptable", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.FieldParamType.filterFieldTypes", "type": "CompoundType", "tags": [], "label": "filterFieldTypes", "description": [], "signature": [ { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, " | \"*\" | ", { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "[]" ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.FieldParamType.onlyAggregatable", "type": "boolean", "tags": [], "label": "onlyAggregatable", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.FieldParamType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.FieldParamType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.FieldParamType.getAvailableFields", "type": "Function", "tags": [], "label": "getAvailableFields", "description": [ "\nfilter the fields to the available ones" ], "signature": [ "(aggConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" }, "[]" ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.FieldParamType.getAvailableFields.$1", "type": "Object", "tags": [], "label": "aggConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError", "type": "Class", "tags": [], "label": "InvalidEsCalendarIntervalError", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.InvalidEsCalendarIntervalError", "text": "InvalidEsCalendarIntervalError" }, " extends Error" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$1", "type": "string", "tags": [], "label": "interval", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$2", "type": "number", "tags": [], "label": "value", "description": [], "signature": [ "number" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$3", "type": "CompoundType", "tags": [], "label": "unit", "description": [], "signature": [ { "pluginId": "@elastic/datemath", "scope": "server", "docId": "kibElasticDatemathPluginApi", "section": "def-server.Unit", "text": "Unit" } ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$4", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.InvalidEsIntervalFormatError", "type": "Class", "tags": [], "label": "InvalidEsIntervalFormatError", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.InvalidEsIntervalFormatError", "text": "InvalidEsIntervalFormatError" }, " extends Error" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.InvalidEsIntervalFormatError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.InvalidEsIntervalFormatError.Unnamed.$1", "type": "string", "tags": [], "label": "interval", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IpAddress", "type": "Class", "tags": [], "label": "IpAddress", "description": [], "path": "src/plugins/data/common/search/aggs/utils/ip_address.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IpAddress.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/utils/ip_address.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IpAddress.Unnamed.$1", "type": "CompoundType", "tags": [], "label": "ipAddress", "description": [], "signature": [ "string | number | number[]" ], "path": "src/plugins/data/common/search/aggs/utils/ip_address.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.IpAddress.toString", "type": "Function", "tags": [], "label": "toString", "description": [], "signature": [ "() => string" ], "path": "src/plugins/data/common/search/aggs/utils/ip_address.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.JsonParamType", "type": "Class", "tags": [], "label": "JsonParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.JsonParamType", "text": "JsonParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/param_types/json.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.JsonParamType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/json.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.JsonParamType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/aggs/param_types/json.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.MetricAggType", "type": "Class", "tags": [], "label": "MetricAggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.MetricAggType.subtype", "type": "string", "tags": [], "label": "subtype", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.MetricAggType.isScalable", "type": "Function", "tags": [], "label": "isScalable", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "data", "id": "def-common.MetricAggType.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.MetricAggType.getKey", "type": "Function", "tags": [], "label": "getKey", "description": [], "signature": [ "() => void" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.MetricAggType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.MetricAggType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "MetricAggTypeConfig" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.OptionedParamType", "type": "Class", "tags": [], "label": "OptionedParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.OptionedParamType", "text": "OptionedParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.OptionedParamType.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.OptionedValueProp", "text": "OptionedValueProp" }, "[]" ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.OptionedParamType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.OptionedParamType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.RequestFailure", "type": "Class", "tags": [], "label": "RequestFailure", "description": [ "\nRequest Failure - When an entire multi request fails" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RequestFailure", "text": "RequestFailure" }, " extends ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.KbnError", "text": "KbnError" } ], "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.RequestFailure.resp", "type": "Object", "tags": [], "label": "resp", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.RequestFailure.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.RequestFailure.Unnamed.$1", "type": "CompoundType", "tags": [], "label": "err", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchError", "text": "SearchError" }, " | null" ], "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.RequestFailure.Unnamed.$2", "type": "Object", "tags": [], "label": "resp", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSource", "type": "Class", "tags": [], "label": "SearchSource", "description": [], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.history", "type": "Array", "tags": [], "label": "history", "description": [], "signature": [ "Record[]" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSource.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.Unnamed.$1", "type": "Object", "tags": [], "label": "fields", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.SearchSource.Unnamed.$2", "type": "Object", "tags": [], "label": "dependencies", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.setPreferredSearchStrategyId", "type": "Function", "tags": [], "label": "setPreferredSearchStrategyId", "description": [ "**\nPUBLIC API\n\ninternal, dont use" ], "signature": [ "(searchStrategyId: string) => void" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.setPreferredSearchStrategyId.$1", "type": "string", "tags": [], "label": "searchStrategyId", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.setField", "type": "Function", "tags": [], "label": "setField", "description": [ "\nsets value to a single search source field" ], "signature": [ "(field: K, value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]) => this" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.setField.$1", "type": "Uncategorized", "tags": [], "label": "field", "description": [ ": field name" ], "signature": [ "K" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.SearchSource.setField.$2", "type": "Uncategorized", "tags": [], "label": "value", "description": [ ": value for the field" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.removeField", "type": "Function", "tags": [], "label": "removeField", "description": [ "\nremove field" ], "signature": [ "(field: K) => this" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.removeField.$1", "type": "Uncategorized", "tags": [], "label": "field", "description": [ ": field name" ], "signature": [ "K" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.setFields", "type": "Function", "tags": [ "private" ], "label": "setFields", "description": [ "\nInternal, do not use. Overrides all search source fields with the new field array.\n" ], "signature": [ "(newFields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => this" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.setFields.$1", "type": "Object", "tags": [], "label": "newFields", "description": [ "New field array." ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.getId", "type": "Function", "tags": [], "label": "getId", "description": [ "\nreturns search source id" ], "signature": [ "() => string" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.getFields", "type": "Function", "tags": [], "label": "getFields", "description": [ "\nreturns all search source fields" ], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.getField", "type": "Function", "tags": [], "label": "getField", "description": [ "\nGets a single field from the fields" ], "signature": [ "(field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.getField.$1", "type": "Uncategorized", "tags": [], "label": "field", "description": [], "signature": [ "K" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.SearchSource.getField.$2", "type": "boolean", "tags": [], "label": "recurse", "description": [], "signature": [ "boolean" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.getOwnField", "type": "Function", "tags": [], "label": "getOwnField", "description": [ "\nGet the field from our own fields, don't traverse up the chain" ], "signature": [ "(field: K) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.getOwnField.$1", "type": "Uncategorized", "tags": [], "label": "field", "description": [], "signature": [ "K" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.create", "type": "Function", "tags": [ "deprecated" ], "label": "create", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": true, "references": [ { "plugin": "discover", "path": "src/plugins/discover/public/application/embeddable/saved_search_embeddable.tsx" }, { "plugin": "discover", "path": "src/plugins/discover/public/application/embeddable/saved_search_embeddable.tsx" } ], "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.createCopy", "type": "Function", "tags": [], "label": "createCopy", "description": [ "\ncreates a copy of this search source (without its children)" ], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.createChild", "type": "Function", "tags": [], "label": "createChild", "description": [ "\ncreates a new child search source" ], "signature": [ "(options?: {}) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.createChild.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "{}" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.setParent", "type": "Function", "tags": [ "return" ], "label": "setParent", "description": [ "\nSet a searchSource that this source should inherit from" ], "signature": [ "(parent?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceOptions", "text": "SearchSourceOptions" }, ") => this" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.setParent.$1", "type": "Object", "tags": [], "label": "parent", "description": [ "- the parent searchSource" ], "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.SearchSource.setParent.$2", "type": "Object", "tags": [], "label": "options", "description": [ "- the inherit options" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceOptions", "text": "SearchSourceOptions" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ "- chainable" ] }, { "parentPluginId": "data", "id": "def-common.SearchSource.getParent", "type": "Function", "tags": [ "return" ], "label": "getParent", "description": [ "\nGet the parent of this SearchSource" ], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.fetch$", "type": "Function", "tags": [], "label": "fetch$", "description": [ "\nFetch this source from Elasticsearch, returning an observable over the response(s)" ], "signature": [ "(options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", "SearchResponse", ">>" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.fetch$.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.fetch", "type": "Function", "tags": [ "deprecated" ], "label": "fetch", "description": [ "\nFetch this source and reject the returned Promise on error" ], "signature": [ "(options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => Promise<", "SearchResponse", ">" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": true, "removeBy": "8.1", "references": [ { "plugin": "discover", "path": "src/plugins/discover/public/application/apps/context/services/anchor.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/application/apps/context/services/utils/fetch_hits_in_interval.ts" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" }, { "plugin": "inputControlVis", "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" }, { "plugin": "inputControlVis", "path": "src/plugins/input_control_vis/public/control/range_control_factory.ts" } ], "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.fetch.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.onRequestStart", "type": "Function", "tags": [ "return" ], "label": "onRequestStart", "description": [ "\n Add a handler that will be notified whenever requests start" ], "signature": [ "(handler: (searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise) => void" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.onRequestStart.$1", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(searchSource: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.getSearchRequestBody", "type": "Function", "tags": [], "label": "getSearchRequestBody", "description": [ "\nReturns body contents of the search request, often referred as query DSL." ], "signature": [ "() => any" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.destroy", "type": "Function", "tags": [ "return" ], "label": "destroy", "description": [ "\nCompletely destroy the SearchSource." ], "signature": [ "() => void" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.getSerializedFields", "type": "Function", "tags": [], "label": "getSerializedFields", "description": [ "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" ], "signature": [ "(recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSource.getSerializedFields.$1", "type": "boolean", "tags": [], "label": "recurse", "description": [], "signature": [ "boolean" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSource.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [ "\nSerializes the instance to a JSON string and a set of referenced objects.\nUse this method to get a representation of the search source which can be stored in a saved object.\n\nThe references returned by this function can be mixed with other references in the same object,\nhowever make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index`\nand `kibanaSavedObjectMeta.searchSourceJSON.filter[].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created." ], "signature": [ "() => { searchSourceJSON: string; references: ", "SavedObjectReference", "[]; }" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceService", "type": "Class", "tags": [], "label": "SearchSourceService", "description": [], "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSourceService.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "() => void" ], "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSourceService.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "(indexPatterns: Pick<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewsService", "text": "DataViewsService" }, ", \"create\" | \"delete\" | \"find\" | \"get\" | \"ensureDefaultDataView\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"hasUserDataView\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\" | \"getDefaultDataView\">, dependencies: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" }, ") => { create: (searchSourceFields?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ">; createEmpty: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; }" ], "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSourceService.start.$1", "type": "Object", "tags": [], "label": "indexPatterns", "description": [], "signature": [ "Pick<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewsService", "text": "DataViewsService" }, ", \"create\" | \"delete\" | \"find\" | \"get\" | \"ensureDefaultDataView\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"hasUserDataView\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\" | \"getDefaultDataView\">" ], "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.SearchSourceService.start.$2", "type": "Object", "tags": [], "label": "dependencies", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" } ], "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.SearchSourceService.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "path": "src/plugins/data/common/search/search_source/search_source_service.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.StringParamType", "type": "Class", "tags": [], "label": "StringParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.StringParamType", "text": "StringParamType" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/param_types/string.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.StringParamType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/param_types/string.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.StringParamType.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/aggs/param_types/string.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "data", "id": "def-common.aggAvg", "type": "Function", "tags": [], "label": "aggAvg", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketAvg", "type": "Function", "tags": [], "label": "aggBucketAvg", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketMax", "type": "Function", "tags": [], "label": "aggBucketMax", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketMin", "type": "Function", "tags": [], "label": "aggBucketMin", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketSum", "type": "Function", "tags": [], "label": "aggBucketSum", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggCardinality", "type": "Function", "tags": [], "label": "aggCardinality", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggCount", "type": "Function", "tags": [], "label": "aggCount", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggCumulativeSum", "type": "Function", "tags": [], "label": "aggCumulativeSum", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggDateHistogram", "type": "Function", "tags": [], "label": "aggDateHistogram", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggDateRange", "type": "Function", "tags": [], "label": "aggDateRange", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggDerivative", "type": "Function", "tags": [], "label": "aggDerivative", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggFilter", "type": "Function", "tags": [], "label": "aggFilter", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggFilteredMetric", "type": "Function", "tags": [], "label": "aggFilteredMetric", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggFilters", "type": "Function", "tags": [], "label": "aggFilters", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoBounds", "type": "Function", "tags": [], "label": "aggGeoBounds", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoCentroid", "type": "Function", "tags": [], "label": "aggGeoCentroid", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoHash", "type": "Function", "tags": [], "label": "aggGeoHash", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoTile", "type": "Function", "tags": [], "label": "aggGeoTile", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggHistogram", "type": "Function", "tags": [], "label": "aggHistogram", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggIpRange", "type": "Function", "tags": [], "label": "aggIpRange", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMax", "type": "Function", "tags": [], "label": "aggMax", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMedian", "type": "Function", "tags": [], "label": "aggMedian", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMin", "type": "Function", "tags": [], "label": "aggMin", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMovingAvg", "type": "Function", "tags": [], "label": "aggMovingAvg", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggPercentileRanks", "type": "Function", "tags": [], "label": "aggPercentileRanks", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggPercentiles", "type": "Function", "tags": [], "label": "aggPercentiles", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggRange", "type": "Function", "tags": [], "label": "aggRange", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSerialDiff", "type": "Function", "tags": [], "label": "aggSerialDiff", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSignificantTerms", "type": "Function", "tags": [], "label": "aggSignificantTerms", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSinglePercentile", "type": "Function", "tags": [], "label": "aggSinglePercentile", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggStdDeviation", "type": "Function", "tags": [], "label": "aggStdDeviation", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSum", "type": "Function", "tags": [], "label": "aggSum", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggTerms", "type": "Function", "tags": [], "label": "aggTerms", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggTopHit", "type": "Function", "tags": [], "label": "aggTopHit", "description": [], "signature": [ "() => FunctionDefinition" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.calcAutoIntervalLessThan", "type": "Function", "tags": [], "label": "calcAutoIntervalLessThan", "description": [ "\nPick a \"pretty\" interval that produces no more than the maxBucketCount\nfor the given time range.\n" ], "signature": [ "(maxBucketCount: number, duration: number) => moment.Duration" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.calcAutoIntervalLessThan.$1", "type": "number", "tags": [], "label": "maxBucketCount", "description": [ "maximum number of buckets to create" ], "signature": [ "number" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.calcAutoIntervalLessThan.$2", "type": "number", "tags": [], "label": "duration", "description": [ "amount of time covered by the agg" ], "signature": [ "number" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.calcAutoIntervalNear", "type": "Function", "tags": [], "label": "calcAutoIntervalNear", "description": [ "\nUsing some simple rules we pick a \"pretty\" interval that will\nproduce around the number of buckets desired given a time range.\n" ], "signature": [ "(targetBucketCount: number, duration: number) => moment.Duration" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.calcAutoIntervalNear.$1", "type": "number", "tags": [], "label": "targetBucketCount", "description": [ "desired number of buckets" ], "signature": [ "number" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.calcAutoIntervalNear.$2", "type": "number", "tags": [], "label": "duration", "description": [ "time range the agg covers" ], "signature": [ "number" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.cidrToAst", "type": "Function", "tags": [], "label": "cidrToAst", "description": [], "signature": [ "(cidr: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/cidr_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.cidrToAst.$1", "type": "Object", "tags": [], "label": "cidr", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" } ], "path": "src/plugins/data/common/search/expressions/cidr_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.convertDateRangeToString", "type": "Function", "tags": [], "label": "convertDateRangeToString", "description": [], "signature": [ "({ from, to }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, ", format: (val: any) => string) => string" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.convertDateRangeToString.$1", "type": "Object", "tags": [], "label": "{ from, to }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" } ], "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.convertDateRangeToString.$2", "type": "Function", "tags": [], "label": "format", "description": [], "signature": [ "(val: any) => string" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.convertIPRangeToString", "type": "Function", "tags": [], "label": "convertIPRangeToString", "description": [], "signature": [ "(range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRangeKey", "text": "IpRangeKey" }, ", format: (val: any) => string) => string" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.convertIPRangeToString.$1", "type": "CompoundType", "tags": [], "label": "range", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRangeKey", "text": "IpRangeKey" } ], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.convertIPRangeToString.$2", "type": "Function", "tags": [], "label": "format", "description": [], "signature": [ "(val: any) => string" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.createSearchSource", "type": "Function", "tags": [ "return" ], "label": "createSearchSource", "description": [ "\nDeserializes a json string and a set of referenced objects to a `SearchSource` instance.\nUse this method to re-create the search source serialized using `searchSource.serialize`.\n\nThis function is a factory function that returns the actual utility when calling it with the\nrequired service dependency (index patterns contract). A pre-wired version is also exposed in\nthe start contract of the data plugin as part of the search service\n" ], "signature": [ "(indexPatterns: Pick<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewsService", "text": "DataViewsService" }, ", \"create\" | \"delete\" | \"find\" | \"get\" | \"ensureDefaultDataView\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"hasUserDataView\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\" | \"getDefaultDataView\">, searchSourceDependencies: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" }, ") => (searchSourceFields?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ">" ], "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.createSearchSource.$1", "type": "Object", "tags": [], "label": "indexPatterns", "description": [ "The index patterns contract of the data plugin" ], "signature": [ "Pick<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewsService", "text": "DataViewsService" }, ", \"create\" | \"delete\" | \"find\" | \"get\" | \"ensureDefaultDataView\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"hasUserDataView\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\" | \"getDefaultDataView\">" ], "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.createSearchSource.$2", "type": "Object", "tags": [], "label": "searchSourceDependencies", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" } ], "path": "src/plugins/data/common/search/search_source/create_search_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ "Wired utility function taking two parameters `searchSourceJson`, the json string\nreturned by `serializeSearchSource` and `references`, a list of references including the ones\nreturned by `serializeSearchSource`." ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.dateHistogramInterval", "type": "Function", "tags": [], "label": "dateHistogramInterval", "description": [ "\nChecks whether a given Elasticsearch interval is a calendar or fixed interval\nand returns an object containing the appropriate date_histogram property for that\ninterval. So it will return either an object containing the fixed_interval key for\nthat interval or a calendar_interval. If the specified interval was not a valid Elasticsearch\ninterval this method will throw an error.\n\nYou can simply spread the returned value of this method into your date_histogram." ], "signature": [ "(interval: string) => Interval" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.dateHistogramInterval.$1", "type": "string", "tags": [], "label": "interval", "description": [ "The interval string to return the appropriate date_histogram key for." ], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.dateRangeToAst", "type": "Function", "tags": [], "label": "dateRangeToAst", "description": [], "signature": [ "(dateRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/date_range_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.dateRangeToAst.$1", "type": "Object", "tags": [], "label": "dateRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" } ], "path": "src/plugins/data/common/search/expressions/date_range_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsToAst", "type": "Function", "tags": [], "label": "extendedBoundsToAst", "description": [], "signature": [ "(extendedBounds: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/extended_bounds_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.extendedBoundsToAst.$1", "type": "Object", "tags": [], "label": "extendedBounds", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" } ], "path": "src/plugins/data/common/search/expressions/extended_bounds_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.extractReferences", "type": "Function", "tags": [], "label": "extractReferences", "description": [], "signature": [ "(state: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, ") => [", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " & { indexRefName?: string | undefined; }, ", "SavedObjectReference", "[]]" ], "path": "src/plugins/data/common/search/search_source/extract_references.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.extractReferences.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "path": "src/plugins/data/common/search/search_source/extract_references.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.filtersToAst", "type": "Function", "tags": [], "label": "filtersToAst", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[]" ], "path": "src/plugins/data/common/search/expressions/filters_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.filtersToAst.$1", "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/data/common/search/expressions/filters_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.flattenHit", "type": "Function", "tags": [], "label": "flattenHit", "description": [ "\nFlattens an individual hit (from an ES response) into an object. This will\ncreate flattened field names, like `user.name`.\n" ], "signature": [ "(hit: Hit, indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined, params: ", "TabifyDocsOptions", " | undefined) => Record" ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.flattenHit.$1", "type": "CompoundType", "tags": [], "label": "hit", "description": [ "The hit from an ES reponse's hits.hits[]" ], "signature": [ "Hit" ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.flattenHit.$2", "type": "Object", "tags": [], "label": "indexPattern", "description": [ "The index pattern for the requested index if available." ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.flattenHit.$3", "type": "Object", "tags": [], "label": "params", "description": [ "Parameters how to flatten the hit" ], "signature": [ "TabifyDocsOptions", " | undefined" ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.functionWrapper", "type": "Function", "tags": [], "label": "functionWrapper", "description": [ "\nTakes a function spec and passes in default args,\noverriding with any provided args." ], "signature": [ "(spec: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ") => (context: object | null, args?: Record, handlers?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">) => any" ], "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.functionWrapper.$1", "type": "Object", "tags": [], "label": "spec", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" } ], "path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxToAst", "type": "Function", "tags": [], "label": "geoBoundingBoxToAst", "description": [], "signature": [ "(geoBoundingBox: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoBoundingBox", "text": "GeoBoundingBox" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxToAst.$1", "type": "CompoundType", "tags": [], "label": "geoBoundingBox", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoBoundingBox", "text": "GeoBoundingBox" } ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.geoPointToAst", "type": "Function", "tags": [], "label": "geoPointToAst", "description": [], "signature": [ "(point: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/geo_point_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoPointToAst.$1", "type": "CompoundType", "tags": [], "label": "point", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" } ], "path": "src/plugins/data/common/search/expressions/geo_point_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getAvgMetricAgg", "type": "Function", "tags": [], "label": "getAvgMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getBucketAvgMetricAgg", "type": "Function", "tags": [], "label": "getBucketAvgMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getBucketMaxMetricAgg", "type": "Function", "tags": [], "label": "getBucketMaxMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getBucketMinMetricAgg", "type": "Function", "tags": [], "label": "getBucketMinMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getBucketSumMetricAgg", "type": "Function", "tags": [], "label": "getBucketSumMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getCalculateAutoTimeExpression", "type": "Function", "tags": [], "label": "getCalculateAutoTimeExpression", "description": [], "signature": [ "(getConfig: (key: string) => any) => (range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => string | undefined" ], "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getCalculateAutoTimeExpression.$1", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string) => any" ], "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getCardinalityMetricAgg", "type": "Function", "tags": [], "label": "getCardinalityMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getCountMetricAgg", "type": "Function", "tags": [], "label": "getCountMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/count.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getCumulativeSumMetricAgg", "type": "Function", "tags": [], "label": "getCumulativeSumMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getDateHistogramBucketAgg", "type": "Function", "tags": [], "label": "getDateHistogramBucketAgg", "description": [], "signature": [ "({ calculateBounds, isDefaultTimezone, getConfig, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateHistogramBucketAggDependencies", "text": "DateHistogramBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketDateHistogramAggConfig", "text": "IBucketDateHistogramAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getDateHistogramBucketAgg.$1", "type": "Object", "tags": [], "label": "{\n calculateBounds,\n isDefaultTimezone,\n getConfig,\n}", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateHistogramBucketAggDependencies", "text": "DateHistogramBucketAggDependencies" } ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getDateHistogramMetaDataByDatatableColumn", "type": "Function", "tags": [], "label": "getDateHistogramMetaDataByDatatableColumn", "description": [ "\nHelper function returning the used interval, used time zone and applied time filters for data table column created by the date_histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a date_histogram aggregation of the esaggs data source,\nthis function will return undefined." ], "signature": [ "(column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ", defaults?: Partial<{ timeZone: string; }>) => { interval: string | undefined; timeZone: string | undefined; timeRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getDateHistogramMetaDataByDatatableColumn.$1", "type": "Object", "tags": [], "label": "column", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" } ], "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.getDateHistogramMetaDataByDatatableColumn.$2", "type": "Object", "tags": [], "label": "defaults", "description": [], "signature": [ "Partial<{ timeZone: string; }>" ], "path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getDateRangeBucketAgg", "type": "Function", "tags": [], "label": "getDateRangeBucketAgg", "description": [], "signature": [ "({ isDefaultTimezone, getConfig, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRangeBucketAggDependencies", "text": "DateRangeBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getDateRangeBucketAgg.$1", "type": "Object", "tags": [], "label": "{\n isDefaultTimezone,\n getConfig,\n}", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRangeBucketAggDependencies", "text": "DateRangeBucketAggDependencies" } ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getDerivativeMetricAgg", "type": "Function", "tags": [], "label": "getDerivativeMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getEsdslFn", "type": "Function", "tags": [], "label": "getEsdslFn", "description": [], "signature": [ "({ getStartDependencies, }: { getStartDependencies: (getKibanaRequest: any) => Promise<", "EsdslStartDependencies", ">; }) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsdslExpressionFunctionDefinition", "text": "EsdslExpressionFunctionDefinition" } ], "path": "src/plugins/data/common/search/expressions/esdsl.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getEsdslFn.$1", "type": "Object", "tags": [], "label": "{\n getStartDependencies,\n}", "description": [], "path": "src/plugins/data/common/search/expressions/esdsl.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getEsdslFn.$1.getStartDependencies", "type": "Function", "tags": [], "label": "getStartDependencies", "description": [], "signature": [ "(getKibanaRequest: any) => Promise<", "EsdslStartDependencies", ">" ], "path": "src/plugins/data/common/search/expressions/esdsl.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getEsdslFn.$1.getStartDependencies.$1", "type": "Any", "tags": [], "label": "getKibanaRequest", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/expressions/esdsl.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getFilterBucketAgg", "type": "Function", "tags": [], "label": "getFilterBucketAgg", "description": [], "signature": [ "({ getConfig }: { getConfig: (key: string) => any; }) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getFilterBucketAgg.$1", "type": "Object", "tags": [], "label": "{ getConfig }", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getFilterBucketAgg.$1.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string) => any" ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getFilterBucketAgg.$1.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getFilteredMetricAgg", "type": "Function", "tags": [], "label": "getFilteredMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getFiltersBucketAgg", "type": "Function", "tags": [], "label": "getFiltersBucketAgg", "description": [], "signature": [ "({ getConfig }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FiltersBucketAggDependencies", "text": "FiltersBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getFiltersBucketAgg.$1", "type": "Object", "tags": [], "label": "{ getConfig }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FiltersBucketAggDependencies", "text": "FiltersBucketAggDependencies" } ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getGeoBoundsMetricAgg", "type": "Function", "tags": [], "label": "getGeoBoundsMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getGeoCentroidMetricAgg", "type": "Function", "tags": [], "label": "getGeoCentroidMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getGeoHashBucketAgg", "type": "Function", "tags": [], "label": "getGeoHashBucketAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getGeoTitleBucketAgg", "type": "Function", "tags": [], "label": "getGeoTitleBucketAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getHistogramBucketAgg", "type": "Function", "tags": [], "label": "getHistogramBucketAgg", "description": [], "signature": [ "({ getConfig, getFieldFormatsStart, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.HistogramBucketAggDependencies", "text": "HistogramBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketHistogramAggConfig", "text": "IBucketHistogramAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getHistogramBucketAgg.$1", "type": "Object", "tags": [], "label": "{\n getConfig,\n getFieldFormatsStart,\n}", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.HistogramBucketAggDependencies", "text": "HistogramBucketAggDependencies" } ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getIpRangeBucketAgg", "type": "Function", "tags": [], "label": "getIpRangeBucketAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getKibanaContextFn", "type": "Function", "tags": [], "label": "getKibanaContextFn", "description": [], "signature": [ "(getStartDependencies: (getKibanaRequest: (() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") | undefined) => Promise<", "KibanaContextStartDependencies", ">) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExpressionFunctionKibanaContext", "text": "ExpressionFunctionKibanaContext" } ], "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getKibanaContextFn.$1", "type": "Function", "tags": [], "label": "getStartDependencies", "description": [], "signature": [ "(getKibanaRequest: (() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") | undefined) => Promise<", "KibanaContextStartDependencies", ">" ], "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getMaxMetricAgg", "type": "Function", "tags": [], "label": "getMaxMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getMedianMetricAgg", "type": "Function", "tags": [], "label": "getMedianMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getMinMetricAgg", "type": "Function", "tags": [], "label": "getMinMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getMovingAvgMetricAgg", "type": "Function", "tags": [], "label": "getMovingAvgMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getNumberHistogramIntervalByDatatableColumn", "type": "Function", "tags": [], "label": "getNumberHistogramIntervalByDatatableColumn", "description": [ "\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined." ], "signature": [ "(column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => number | undefined" ], "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getNumberHistogramIntervalByDatatableColumn.$1", "type": "Object", "tags": [], "label": "column", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" } ], "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getPercentileRanksMetricAgg", "type": "Function", "tags": [], "label": "getPercentileRanksMetricAgg", "description": [], "signature": [ "({ getFieldFormatsStart, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.PercentileRanksMetricAggDependencies", "text": "PercentileRanksMetricAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", "IResponseAggConfig", ">" ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getPercentileRanksMetricAgg.$1", "type": "Object", "tags": [], "label": "{\n getFieldFormatsStart,\n}", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.PercentileRanksMetricAggDependencies", "text": "PercentileRanksMetricAggDependencies" } ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getPercentilesMetricAgg", "type": "Function", "tags": [], "label": "getPercentilesMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", "IResponseAggConfig", ">" ], "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getPreference", "type": "Function", "tags": [], "label": "getPreference", "description": [], "signature": [ "(getConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" }, ") => any" ], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getPreference.$1", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" } ], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getRangeBucketAgg", "type": "Function", "tags": [], "label": "getRangeBucketAgg", "description": [], "signature": [ "({ getFieldFormatsStart }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeBucketAggDependencies", "text": "RangeBucketAggDependencies" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getRangeBucketAgg.$1", "type": "Object", "tags": [], "label": "{ getFieldFormatsStart }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeBucketAggDependencies", "text": "RangeBucketAggDependencies" } ], "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getResponseInspectorStats", "type": "Function", "tags": [], "label": "getResponseInspectorStats", "description": [], "signature": [ "(resp: ", "SearchResponse", " | undefined, searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined) => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestStatistics", "text": "RequestStatistics" } ], "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getResponseInspectorStats.$1", "type": "Object", "tags": [], "label": "resp", "description": [], "signature": [ "SearchResponse", " | undefined" ], "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.getResponseInspectorStats.$2", "type": "Object", "tags": [], "label": "searchSource", "description": [], "signature": [ "Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined" ], "path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getSearchParams", "type": "Function", "tags": [], "label": "getSearchParams", "description": [], "signature": [ "(getConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" }, ") => { preference: any; }" ], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getSearchParams.$1", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" } ], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest", "type": "Function", "tags": [], "label": "getSearchParamsFromRequest", "description": [], "signature": [ "(searchRequest: Record, dependencies: { getConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.GetConfigFn", "text": "GetConfigFn" }, "; }) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchRequestParams", "text": "ISearchRequestParams" } ], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$1", "type": "Object", "tags": [], "label": "searchRequest", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$2", "type": "Object", "tags": [], "label": "dependencies", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$2.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string, defaultOverride?: T | undefined) => T" ], "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$2.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], "path": "src/plugins/data/common/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.getSearchParamsFromRequest.$2.getConfig.$2", "type": "Uncategorized", "tags": [], "label": "defaultOverride", "description": [], "signature": [ "T | undefined" ], "path": "src/plugins/data/common/types.ts", "deprecated": false } ] } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getSerialDiffMetricAgg", "type": "Function", "tags": [], "label": "getSerialDiffMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getSignificantTermsBucketAgg", "type": "Function", "tags": [], "label": "getSignificantTermsBucketAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getSinglePercentileMetricAgg", "type": "Function", "tags": [], "label": "getSinglePercentileMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getStdDeviationMetricAgg", "type": "Function", "tags": [], "label": "getStdDeviationMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IStdDevAggConfig", "text": "IStdDevAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getSumMetricAgg", "type": "Function", "tags": [], "label": "getSumMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getTermsBucketAgg", "type": "Function", "tags": [], "label": "getTermsBucketAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.getTopHitMetricAgg", "type": "Function", "tags": [], "label": "getTopHitMetricAgg", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.handleRequest", "type": "Function", "tags": [], "label": "handleRequest", "description": [], "signature": [ "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, executionContext, }: ", "RequestHandlerParams", ") => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">" ], "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.handleRequest.$1", "type": "Object", "tags": [], "label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n partialRows,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n executionContext,\n}", "description": [], "signature": [ "RequestHandlerParams" ], "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.inferTimeZone", "type": "Function", "tags": [], "label": "inferTimeZone", "description": [], "signature": [ "(params: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateHistogram", "text": "AggParamsDateHistogram" }, ", indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, ", isDefaultTimezone: () => boolean, getConfig: (key: string) => T) => string" ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.inferTimeZone.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateHistogram", "text": "AggParamsDateHistogram" } ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.inferTimeZone.$2", "type": "Object", "tags": [], "label": "indexPattern", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" } ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.inferTimeZone.$3", "type": "Function", "tags": [], "label": "isDefaultTimezone", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.inferTimeZone.$4", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string) => T" ], "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.injectReferences", "type": "Function", "tags": [], "label": "injectReferences", "description": [], "signature": [ "(searchSourceFields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " & { indexRefName: string; }, references: ", "SavedObjectReference", "[]) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "path": "src/plugins/data/common/search/search_source/inject_references.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.injectReferences.$1", "type": "CompoundType", "tags": [], "label": "searchSourceFields", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " & { indexRefName: string; }" ], "path": "src/plugins/data/common/search/search_source/inject_references.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.injectReferences.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ "SavedObjectReference", "[]" ], "path": "src/plugins/data/common/search/search_source/inject_references.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ipRangeToAst", "type": "Function", "tags": [], "label": "ipRangeToAst", "description": [], "signature": [ "(ipRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/ip_range_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ipRangeToAst.$1", "type": "Object", "tags": [], "label": "ipRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" } ], "path": "src/plugins/data/common/search/expressions/ip_range_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isAutoInterval", "type": "Function", "tags": [], "label": "isAutoInterval", "description": [], "signature": [ "(value: unknown) => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isAutoInterval.$1", "type": "Unknown", "tags": [], "label": "value", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isBucketAggType", "type": "Function", "tags": [], "label": "isBucketAggType", "description": [], "signature": [ "(aggConfig: any) => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isBucketAggType.$1", "type": "Any", "tags": [], "label": "aggConfig", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isCompleteResponse", "type": "Function", "tags": [], "label": "isCompleteResponse", "description": [], "signature": [ "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined) => boolean" ], "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isCompleteResponse.$1", "type": "Object", "tags": [], "label": "response", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "isRequired": false } ], "returnComment": [ "true if response is completed successfully" ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isDateHistogramBucketAggConfig", "type": "Function", "tags": [], "label": "isDateHistogramBucketAggConfig", "description": [], "signature": [ "(agg: any) => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isDateHistogramBucketAggConfig.$1", "type": "Any", "tags": [], "label": "agg", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isErrorResponse", "type": "Function", "tags": [], "label": "isErrorResponse", "description": [], "signature": [ "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined) => boolean" ], "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isErrorResponse.$1", "type": "Object", "tags": [], "label": "response", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "isRequired": false } ], "returnComment": [ "true if response had an error while executing in ES" ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isMetricAggType", "type": "Function", "tags": [], "label": "isMetricAggType", "description": [], "signature": [ "(aggConfig: any) => boolean" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isMetricAggType.$1", "type": "Any", "tags": [], "label": "aggConfig", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isNumberType", "type": "Function", "tags": [], "label": "isNumberType", "description": [], "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.isNumberType.$1", "type": "Object", "tags": [], "label": "agg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isPartialResponse", "type": "Function", "tags": [], "label": "isPartialResponse", "description": [], "signature": [ "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined) => boolean" ], "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isPartialResponse.$1", "type": "Object", "tags": [], "label": "response", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " | undefined" ], "path": "src/plugins/data/common/search/utils.ts", "deprecated": false, "isRequired": false } ], "returnComment": [ "true if request is still running an/d response contains partial results" ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isStringOrNumberType", "type": "Function", "tags": [], "label": "isStringOrNumberType", "description": [], "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.isStringOrNumberType.$1", "type": "Object", "tags": [], "label": "agg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isStringType", "type": "Function", "tags": [], "label": "isStringType", "description": [], "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.isStringType.$1", "type": "Object", "tags": [], "label": "agg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isType", "type": "Function", "tags": [], "label": "isType", "description": [], "signature": [ "(...types: string[]) => (agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isType.$1", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isValidEsInterval", "type": "Function", "tags": [], "label": "isValidEsInterval", "description": [ "\nChecks whether a given interval string (e.g. 1w, 24h, ...) is a valid Elasticsearch interval.\nWill return false if the interval is not valid in Elasticsearch, otherwise true.\nInvalid intervals might be: 2f, since there is no unit 'f'; 2w, since weeks and month intervals\nare only allowed with a value of 1, etc.\n" ], "signature": [ "(interval: string) => boolean" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isValidEsInterval.$1", "type": "string", "tags": [], "label": "interval", "description": [ "The interval string like 1w, 24h" ], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ "True if the interval is valid for Elasticsearch" ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.isValidInterval", "type": "Function", "tags": [], "label": "isValidInterval", "description": [], "signature": [ "(value: string, baseInterval: string | undefined) => boolean" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.isValidInterval.$1", "type": "string", "tags": [], "label": "value", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.isValidInterval.$2", "type": "string", "tags": [], "label": "baseInterval", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeToAst", "type": "Function", "tags": [], "label": "numericalRangeToAst", "description": [], "signature": [ "(numericalRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/numerical_range_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.numericalRangeToAst.$1", "type": "Object", "tags": [], "label": "numericalRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" } ], "path": "src/plugins/data/common/search/expressions/numerical_range_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.parseEsInterval", "type": "Function", "tags": [], "label": "parseEsInterval", "description": [ "\nExtracts interval properties from an ES interval string. Disallows unrecognized interval formats\nand fractional values. Converts some intervals from \"calendar\" to \"fixed\" when the number of\nunits is larger than 1, and throws an error for others.\n\nConversion rules:\n\n| Interval | Single unit type | Multiple units type |\n| -------- | ---------------- | ------------------- |\n| ms | fixed | fixed |\n| s | fixed | fixed |\n| m | calendar | fixed |\n| h | calendar | fixed |\n| d | calendar | fixed |\n| w | calendar | N/A - disallowed |\n| M | calendar | N/A - disallowed |\n| y | calendar | N/A - disallowed |\n" ], "signature": [ "(interval: string) => { value: number; unit: ", { "pluginId": "@elastic/datemath", "scope": "server", "docId": "kibElasticDatemathPluginApi", "section": "def-server.Unit", "text": "Unit" }, "; type: \"calendar\" | \"fixed\"; }" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.parseEsInterval.$1", "type": "string", "tags": [], "label": "interval", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.parseInterval", "type": "Function", "tags": [], "label": "parseInterval", "description": [], "signature": [ "(interval: string) => moment.Duration | null" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.parseInterval.$1", "type": "string", "tags": [], "label": "interval", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.parseSearchSourceJSON", "type": "Function", "tags": [], "label": "parseSearchSourceJSON", "description": [], "signature": [ "(searchSourceJSON: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ], "path": "src/plugins/data/common/search/search_source/parse_json.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.parseSearchSourceJSON.$1", "type": "string", "tags": [], "label": "searchSourceJSON", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/search_source/parse_json.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.parseTimeShift", "type": "Function", "tags": [], "label": "parseTimeShift", "description": [ "\nThis method parses a string into a time shift duration.\nIf parsing fails, 'invalid' is returned.\nAllowed values are the string 'previous' and an integer followed by the units s,m,h,d,w,M,y" ], "signature": [ "(val: string) => moment.Duration | \"previous\" | \"invalid\"" ], "path": "src/plugins/data/common/search/aggs/utils/parse_time_shift.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.parseTimeShift.$1", "type": "string", "tags": [], "label": "val", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/parse_time_shift.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.pollSearch", "type": "Function", "tags": [], "label": "pollSearch", "description": [], "signature": [ ">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAsyncSearchOptions", "text": "IAsyncSearchOptions" }, ") => ", "Observable", "" ], "path": "src/plugins/data/common/search/poll_search.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.pollSearch.$1", "type": "Function", "tags": [], "label": "search", "description": [], "signature": [ "() => Promise" ], "path": "src/plugins/data/common/search/poll_search.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.pollSearch.$2", "type": "Function", "tags": [], "label": "cancel", "description": [], "signature": [ "(() => void) | undefined" ], "path": "src/plugins/data/common/search/poll_search.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.pollSearch.$3", "type": "Object", "tags": [], "label": "{ pollInterval = 1000, abortSignal }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAsyncSearchOptions", "text": "IAsyncSearchOptions" } ], "path": "src/plugins/data/common/search/poll_search.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.propFilter", "type": "Function", "tags": [], "label": "propFilter", "description": [ "\nFilters out a list by a given filter. This is currently used to implement:\n - fieldType filters a list of fields by their type property\n - aggFilter filters a list of aggs by their name property\n" ], "signature": [ "(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]" ], "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.propFilter.$1", "type": "Uncategorized", "tags": [], "label": "prop", "description": [], "signature": [ "P" ], "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ "the filter function which can be registered with angular" ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.queryFilterToAst", "type": "Function", "tags": [], "label": "queryFilterToAst", "description": [], "signature": [ "({ input, label }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/query_filter_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.queryFilterToAst.$1", "type": "Object", "tags": [], "label": "{ input, label }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" } ], "path": "src/plugins/data/common/search/expressions/query_filter_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.queryToAst", "type": "Function", "tags": [], "label": "queryToAst", "description": [], "signature": [ "(query: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/query_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.queryToAst.$1", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" } ], "path": "src/plugins/data/common/search/expressions/query_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.splitStringInterval", "type": "Function", "tags": [], "label": "splitStringInterval", "description": [], "signature": [ "(interval: string) => { value: number; unit: ", { "pluginId": "@elastic/datemath", "scope": "server", "docId": "kibElasticDatemathPluginApi", "section": "def-server.Unit", "text": "Unit" }, "; } | null" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.splitStringInterval.$1", "type": "string", "tags": [], "label": "interval", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.tabifyAggResponse", "type": "Function", "tags": [], "label": "tabifyAggResponse", "description": [ "\nSets up the ResponseWriter and kicks off bucket collection." ], "signature": [ "(aggConfigs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, ", esResponse: Record, respOpts: Partial<", "TabbedResponseWriterOptions", "> | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/data/common/search/tabify/tabify.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.tabifyAggResponse.$1", "type": "Object", "tags": [], "label": "aggConfigs", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ], "path": "src/plugins/data/common/search/tabify/tabify.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.tabifyAggResponse.$2", "type": "Object", "tags": [], "label": "esResponse", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/tabify/tabify.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.tabifyAggResponse.$3", "type": "Object", "tags": [], "label": "respOpts", "description": [], "signature": [ "Partial<", "TabbedResponseWriterOptions", "> | undefined" ], "path": "src/plugins/data/common/search/tabify/tabify.ts", "deprecated": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.tabifyDocs", "type": "Function", "tags": [], "label": "tabifyDocs", "description": [], "signature": [ "(esResponse: ", "SearchResponse", ", index?: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined, params?: ", "TabifyDocsOptions", ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.tabifyDocs.$1", "type": "Object", "tags": [], "label": "esResponse", "description": [], "signature": [ "SearchResponse", "" ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.tabifyDocs.$2", "type": "Object", "tags": [], "label": "index", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.tabifyDocs.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "TabifyDocsOptions" ], "path": "src/plugins/data/common/search/tabify/tabify_docs.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.tabifyGetColumns", "type": "Function", "tags": [], "label": "tabifyGetColumns", "description": [ "\nBuilds tabify columns.\n" ], "signature": [ "(aggs: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[], minimalColumns: boolean) => ", "TabbedAggColumn", "[]" ], "path": "src/plugins/data/common/search/tabify/get_columns.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.tabifyGetColumns.$1", "type": "Array", "tags": [], "label": "aggs", "description": [ "- the agg configs object to which the aggregation response correlates" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, "[]" ], "path": "src/plugins/data/common/search/tabify/get_columns.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.tabifyGetColumns.$2", "type": "boolean", "tags": [], "label": "minimalColumns", "description": [ "- setting to true will only return a column for the last bucket/metric instead of one for each level" ], "signature": [ "boolean" ], "path": "src/plugins/data/common/search/tabify/get_columns.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.timerangeToAst", "type": "Function", "tags": [], "label": "timerangeToAst", "description": [], "signature": [ "(timerange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.timerangeToAst.$1", "type": "Object", "tags": [], "label": "timerange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.toAbsoluteDates", "type": "Function", "tags": [], "label": "toAbsoluteDates", "description": [], "signature": [ "(range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => { from: Date; to: Date; } | undefined" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.toAbsoluteDates.$1", "type": "Object", "tags": [], "label": "range", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "data", "id": "def-common.AggConfigsOptions", "type": "Interface", "tags": [], "label": "AggConfigsOptions", "description": [], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggConfigsOptions.typesRegistry", "type": "Object", "tags": [], "label": "typesRegistry", "description": [], "signature": [ "AggTypesRegistryStart" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggConfigsOptions.hierarchical", "type": "CompoundType", "tags": [], "label": "hierarchical", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping", "type": "Interface", "tags": [], "label": "AggFunctionsMapping", "description": [ "\nA global list of the expression function definitions for each agg type function." ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggFilter", "type": "Object", "tags": [], "label": "aggFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggFilter\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, "> | undefined; }, \"filter\" | \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, "> | undefined; }, never>, \"id\" | \"filter\" | \"enabled\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"customLabel\" | \"timeShift\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggFilters", "type": "Object", "tags": [], "label": "aggFilters", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggFilters\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ filters?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query_filter\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" }, ">[] | undefined; }, \"filters\"> & Pick<{ filters?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query_filter\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" }, ">[] | undefined; }, never>, \"id\" | \"filters\" | \"enabled\" | \"schema\" | \"json\" | \"timeShift\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSignificantTerms", "type": "Object", "tags": [], "label": "aggSignificantTerms", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggSignificantTerms\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BUCKET_TYPES", "text": "BUCKET_TYPES" }, ".SIGNIFICANT_TERMS>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggIpRange", "type": "Object", "tags": [], "label": "aggIpRange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggIpRange\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"cidr\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" }, "> | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"ip_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" }, ">)[] | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"cidr\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" }, "> | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"ip_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" }, ">)[] | undefined; ipRangeType?: string | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"ipRangeType\" | \"ranges\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggDateRange", "type": "Object", "tags": [], "label": "aggDateRange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggDateRange\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"date_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, ">[] | undefined; }, \"ranges\"> & Pick<{ ranges?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"date_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, ">[] | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"ranges\" | \"time_zone\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggRange", "type": "Object", "tags": [], "label": "aggRange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggRange\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"numerical_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" }, ">[] | undefined; }, \"ranges\"> & Pick<{ ranges?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"numerical_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" }, ">[] | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"ranges\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoTile", "type": "Object", "tags": [], "label": "aggGeoTile", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggGeoTile\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BUCKET_TYPES", "text": "BUCKET_TYPES" }, ".GEOTILE_GRID>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoHash", "type": "Object", "tags": [], "label": "aggGeoHash", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggGeoHash\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\" | \"boundingBox\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggHistogram", "type": "Object", "tags": [], "label": "aggHistogram", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggHistogram\", any, Pick, \"interval\" | \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\"> & Pick<{ extended_bounds?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"extended_bounds\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, "> | undefined; }, \"extended_bounds\"> & Pick<{ extended_bounds?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"extended_bounds\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, "> | undefined; }, never>, \"interval\" | \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\" | \"extended_bounds\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggDateHistogram", "type": "Object", "tags": [], "label": "aggDateHistogram", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggDateHistogram\", any, Pick, \"interval\" | \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\"> & Pick<{ timeRange?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"timerange\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "> | undefined; extended_bounds?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"extended_bounds\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, "> | undefined; }, \"timeRange\" | \"extended_bounds\"> & Pick<{ timeRange?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"timerange\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, "> | undefined; extended_bounds?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"extended_bounds\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, "> | undefined; }, never>, \"interval\" | \"id\" | \"timeRange\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"extended_bounds\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggTerms", "type": "Object", "tags": [], "label": "aggTerms", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggTerms\", any, Pick, \"id\" | \"size\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"orderBy\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\"> & Pick<{ orderAgg?: ", "AggExpressionType", " | undefined; }, \"orderAgg\"> & Pick<{ orderAgg?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"size\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"field\" | \"orderBy\" | \"orderAgg\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggAvg", "type": "Object", "tags": [], "label": "aggAvg", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggAvg\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".AVG>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketAvg", "type": "Object", "tags": [], "label": "aggBucketAvg", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggBucketAvg\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketMax", "type": "Object", "tags": [], "label": "aggBucketMax", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggBucketMax\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketMin", "type": "Object", "tags": [], "label": "aggBucketMin", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggBucketMin\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggBucketSum", "type": "Object", "tags": [], "label": "aggBucketSum", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggBucketSum\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggFilteredMetric", "type": "Object", "tags": [], "label": "aggFilteredMetric", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggFilteredMetric\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ", "AggExpressionType", " | undefined; customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"customBucket\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggCardinality", "type": "Object", "tags": [], "label": "aggCardinality", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggCardinality\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".CARDINALITY>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggCount", "type": "Object", "tags": [], "label": "aggCount", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggCount\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".COUNT>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggCumulativeSum", "type": "Object", "tags": [], "label": "aggCumulativeSum", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggCumulativeSum\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggDerivative", "type": "Object", "tags": [], "label": "aggDerivative", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggDerivative\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoBounds", "type": "Object", "tags": [], "label": "aggGeoBounds", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggGeoBounds\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".GEO_BOUNDS>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggGeoCentroid", "type": "Object", "tags": [], "label": "aggGeoCentroid", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggGeoCentroid\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".GEO_CENTROID>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMax", "type": "Object", "tags": [], "label": "aggMax", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggMax\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".MAX>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMedian", "type": "Object", "tags": [], "label": "aggMedian", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggMedian\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".MEDIAN>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSinglePercentile", "type": "Object", "tags": [], "label": "aggSinglePercentile", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggSinglePercentile\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".SINGLE_PERCENTILE>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMin", "type": "Object", "tags": [], "label": "aggMin", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggMin\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".MIN>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggMovingAvg", "type": "Object", "tags": [], "label": "aggMovingAvg", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggMovingAvg\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggPercentileRanks", "type": "Object", "tags": [], "label": "aggPercentileRanks", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggPercentileRanks\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".PERCENTILE_RANKS>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggPercentiles", "type": "Object", "tags": [], "label": "aggPercentiles", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggPercentiles\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".PERCENTILES>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSerialDiff", "type": "Object", "tags": [], "label": "aggSerialDiff", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggSerialDiff\", any, Pick, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ", "AggExpressionType", " | undefined; }, never>, \"id\" | \"enabled\" | \"schema\" | \"json\" | \"customLabel\" | \"timeShift\" | \"customMetric\" | \"buckets_path\" | \"metricAgg\">, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggStdDeviation", "type": "Object", "tags": [], "label": "aggStdDeviation", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggStdDeviation\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".STD_DEV>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggSum", "type": "Object", "tags": [], "label": "aggSum", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggSum\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".SUM>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggTopHit", "type": "Object", "tags": [], "label": "aggTopHit", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"aggTopHit\", any, ", "AggExpressionFunctionArgs", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.METRIC_TYPES", "text": "METRIC_TYPES" }, ".TOP_HITS>, ", "AggExpressionType", ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamOption", "type": "Interface", "tags": [], "label": "AggParamOption", "description": [], "path": "src/plugins/data/common/search/aggs/agg_params.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamOption.val", "type": "string", "tags": [], "label": "val", "description": [], "path": "src/plugins/data/common/search/aggs/agg_params.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamOption.display", "type": "string", "tags": [], "label": "display", "description": [], "path": "src/plugins/data/common/search/aggs/agg_params.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamOption.enabled", "type": "Function", "tags": [], "label": "enabled", "description": [], "signature": [ "((agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_params.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamOption.enabled.$1", "type": "Object", "tags": [], "label": "agg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/agg_params.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsAvg", "type": "Interface", "tags": [], "label": "AggParamsAvg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsAvg", "text": "AggParamsAvg" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsAvg.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketAvg", "type": "Interface", "tags": [], "label": "AggParamsBucketAvg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketAvg", "text": "AggParamsBucketAvg" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsBucketAvg.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketAvg.customBucket", "type": "Object", "tags": [], "label": "customBucket", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketMax", "type": "Interface", "tags": [], "label": "AggParamsBucketMax", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketMax", "text": "AggParamsBucketMax" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsBucketMax.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketMax.customBucket", "type": "Object", "tags": [], "label": "customBucket", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketMin", "type": "Interface", "tags": [], "label": "AggParamsBucketMin", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketMin", "text": "AggParamsBucketMin" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsBucketMin.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketMin.customBucket", "type": "Object", "tags": [], "label": "customBucket", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketSum", "type": "Interface", "tags": [], "label": "AggParamsBucketSum", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsBucketSum", "text": "AggParamsBucketSum" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsBucketSum.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsBucketSum.customBucket", "type": "Object", "tags": [], "label": "customBucket", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsCardinality", "type": "Interface", "tags": [], "label": "AggParamsCardinality", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsCardinality", "text": "AggParamsCardinality" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsCardinality.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum", "type": "Interface", "tags": [], "label": "AggParamsCumulativeSum", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsCumulativeSum", "text": "AggParamsCumulativeSum" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum.buckets_path", "type": "string", "tags": [], "label": "buckets_path", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsCumulativeSum.metricAgg", "type": "string", "tags": [], "label": "metricAgg", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram", "type": "Interface", "tags": [], "label": "AggParamsDateHistogram", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateHistogram", "text": "AggParamsDateHistogram" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.field", "type": "CompoundType", "tags": [], "label": "field", "description": [], "signature": [ "string | ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IFieldType", "text": "IFieldType" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.timeRange", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.useNormalizedEsInterval", "type": "CompoundType", "tags": [], "label": "useNormalizedEsInterval", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.scaleMetricValues", "type": "CompoundType", "tags": [], "label": "scaleMetricValues", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.interval", "type": "string", "tags": [], "label": "interval", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.used_interval", "type": "string", "tags": [], "label": "used_interval", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.time_zone", "type": "string", "tags": [], "label": "time_zone", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.used_time_zone", "type": "string", "tags": [], "label": "used_time_zone", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.drop_partials", "type": "CompoundType", "tags": [], "label": "drop_partials", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.format", "type": "string", "tags": [], "label": "format", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.min_doc_count", "type": "number", "tags": [], "label": "min_doc_count", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateHistogram.extended_bounds", "type": "Object", "tags": [], "label": "extended_bounds", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateRange", "type": "Interface", "tags": [], "label": "AggParamsDateRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDateRange", "text": "AggParamsDateRange" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsDateRange.field", "type": "string", "tags": [], "label": "field", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateRange.ranges", "type": "Array", "tags": [], "label": "ranges", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, "[] | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDateRange.time_zone", "type": "string", "tags": [], "label": "time_zone", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDerivative", "type": "Interface", "tags": [], "label": "AggParamsDerivative", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsDerivative", "text": "AggParamsDerivative" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsDerivative.buckets_path", "type": "string", "tags": [], "label": "buckets_path", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDerivative.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsDerivative.metricAgg", "type": "string", "tags": [], "label": "metricAgg", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsFilter", "type": "Interface", "tags": [], "label": "AggParamsFilter", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsFilter", "text": "AggParamsFilter" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsFilter.geo_bounding_box", "type": "CompoundType", "tags": [], "label": "geo_bounding_box", "description": [], "signature": [ "GeoBox | { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; } | { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; } | WellKnownText | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsFilter.filter", "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsFilteredMetric", "type": "Interface", "tags": [], "label": "AggParamsFilteredMetric", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsFilteredMetric", "text": "AggParamsFilteredMetric" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsFilteredMetric.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsFilteredMetric.customBucket", "type": "Object", "tags": [], "label": "customBucket", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsFilters", "type": "Interface", "tags": [], "label": "AggParamsFilters", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsFilters", "text": "AggParamsFilters" }, " extends Pick<", "BaseAggParams", ", \"json\" | \"timeShift\">" ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsFilters.filters", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" }, "[] | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoBounds", "type": "Interface", "tags": [], "label": "AggParamsGeoBounds", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoBounds", "text": "AggParamsGeoBounds" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsGeoBounds.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoCentroid", "type": "Interface", "tags": [], "label": "AggParamsGeoCentroid", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoCentroid", "text": "AggParamsGeoCentroid" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsGeoCentroid.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoHash", "type": "Interface", "tags": [], "label": "AggParamsGeoHash", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoHash", "text": "AggParamsGeoHash" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.autoPrecision", "type": "CompoundType", "tags": [], "label": "autoPrecision", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.precision", "type": "number", "tags": [], "label": "precision", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.useGeocentroid", "type": "CompoundType", "tags": [], "label": "useGeocentroid", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.isFilteredByCollar", "type": "CompoundType", "tags": [], "label": "isFilteredByCollar", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoHash.boundingBox", "type": "CompoundType", "tags": [], "label": "boundingBox", "description": [], "signature": [ "GeoBox | { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; } | { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; } | WellKnownText | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoTile", "type": "Interface", "tags": [], "label": "AggParamsGeoTile", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsGeoTile", "text": "AggParamsGeoTile" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsGeoTile.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoTile.useGeocentroid", "type": "CompoundType", "tags": [], "label": "useGeocentroid", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoTile.precision", "type": "number", "tags": [], "label": "precision", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram", "type": "Interface", "tags": [], "label": "AggParamsHistogram", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsHistogram", "text": "AggParamsHistogram" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.interval", "type": "CompoundType", "tags": [], "label": "interval", "description": [], "signature": [ "string | number" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.used_interval", "type": "CompoundType", "tags": [], "label": "used_interval", "description": [], "signature": [ "string | number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.maxBars", "type": "number", "tags": [], "label": "maxBars", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.intervalBase", "type": "number", "tags": [], "label": "intervalBase", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.min_doc_count", "type": "CompoundType", "tags": [], "label": "min_doc_count", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.has_extended_bounds", "type": "CompoundType", "tags": [], "label": "has_extended_bounds", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsHistogram.extended_bounds", "type": "Object", "tags": [], "label": "extended_bounds", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsIpRange", "type": "Interface", "tags": [], "label": "AggParamsIpRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsIpRange", "text": "AggParamsIpRange" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsIpRange.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsIpRange.ipRangeType", "type": "CompoundType", "tags": [], "label": "ipRangeType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IP_RANGE_TYPES", "text": "IP_RANGE_TYPES" }, " | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsIpRange.ranges", "type": "Object", "tags": [], "label": "ranges", "description": [], "signature": [ "Partial<{ fromTo: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeIpRangeAggKey", "text": "RangeIpRangeAggKey" }, "[]; mask: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.CidrMaskIpRangeAggKey", "text": "CidrMaskIpRangeAggKey" }, "[]; }> | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMax", "type": "Interface", "tags": [], "label": "AggParamsMax", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMax", "text": "AggParamsMax" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsMax.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/max.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMedian", "type": "Interface", "tags": [], "label": "AggParamsMedian", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMedian", "text": "AggParamsMedian" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsMedian.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/median.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMin", "type": "Interface", "tags": [], "label": "AggParamsMin", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMin", "text": "AggParamsMin" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsMin.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/min.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg", "type": "Interface", "tags": [], "label": "AggParamsMovingAvg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsMovingAvg", "text": "AggParamsMovingAvg" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.buckets_path", "type": "string", "tags": [], "label": "buckets_path", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.window", "type": "number", "tags": [], "label": "window", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.script", "type": "string", "tags": [], "label": "script", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsMovingAvg.metricAgg", "type": "string", "tags": [], "label": "metricAgg", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsPercentileRanks", "type": "Interface", "tags": [], "label": "AggParamsPercentileRanks", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsPercentileRanks", "text": "AggParamsPercentileRanks" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsPercentileRanks.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsPercentileRanks.values", "type": "Array", "tags": [], "label": "values", "description": [], "signature": [ "number[] | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsPercentiles", "type": "Interface", "tags": [], "label": "AggParamsPercentiles", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsPercentiles", "text": "AggParamsPercentiles" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsPercentiles.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsPercentiles.percents", "type": "Array", "tags": [], "label": "percents", "description": [], "signature": [ "number[] | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsRange", "type": "Interface", "tags": [], "label": "AggParamsRange", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsRange", "text": "AggParamsRange" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsRange.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsRange.ranges", "type": "Array", "tags": [], "label": "ranges", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" }, "[] | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff", "type": "Interface", "tags": [], "label": "AggParamsSerialDiff", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsSerialDiff", "text": "AggParamsSerialDiff" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff.buckets_path", "type": "string", "tags": [], "label": "buckets_path", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff.customMetric", "type": "Object", "tags": [], "label": "customMetric", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSerialDiff.metricAgg", "type": "string", "tags": [], "label": "metricAgg", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms", "type": "Interface", "tags": [], "label": "AggParamsSignificantTerms", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsSignificantTerms", "text": "AggParamsSignificantTerms" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.size", "type": "number", "tags": [], "label": "size", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.exclude", "type": "string", "tags": [], "label": "exclude", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSignificantTerms.include", "type": "string", "tags": [], "label": "include", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSinglePercentile", "type": "Interface", "tags": [], "label": "AggParamsSinglePercentile", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsSinglePercentile", "text": "AggParamsSinglePercentile" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsSinglePercentile.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSinglePercentile.percentile", "type": "number", "tags": [], "label": "percentile", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsStdDeviation", "type": "Interface", "tags": [], "label": "AggParamsStdDeviation", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsStdDeviation", "text": "AggParamsStdDeviation" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsStdDeviation.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsSum", "type": "Interface", "tags": [], "label": "AggParamsSum", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsSum", "text": "AggParamsSum" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsSum.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms", "type": "Interface", "tags": [], "label": "AggParamsTerms", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsTerms", "text": "AggParamsTerms" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsTerms.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.orderBy", "type": "string", "tags": [], "label": "orderBy", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.orderAgg", "type": "Object", "tags": [], "label": "orderAgg", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.order", "type": "CompoundType", "tags": [], "label": "order", "description": [], "signature": [ "\"asc\" | \"desc\" | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.size", "type": "number", "tags": [], "label": "size", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.missingBucket", "type": "CompoundType", "tags": [], "label": "missingBucket", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.missingBucketLabel", "type": "string", "tags": [], "label": "missingBucketLabel", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.otherBucket", "type": "CompoundType", "tags": [], "label": "otherBucket", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.otherBucketLabel", "type": "string", "tags": [], "label": "otherBucketLabel", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.exclude", "type": "string", "tags": [], "label": "exclude", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.include", "type": "string", "tags": [], "label": "include", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTopHit", "type": "Interface", "tags": [], "label": "AggParamsTopHit", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamsTopHit", "text": "AggParamsTopHit" }, " extends ", "BaseAggParams" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggParamsTopHit.field", "type": "string", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTopHit.aggregate", "type": "CompoundType", "tags": [], "label": "aggregate", "description": [], "signature": [ "\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\"" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTopHit.sortField", "type": "string", "tags": [], "label": "sortField", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTopHit.size", "type": "number", "tags": [], "label": "size", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggParamsTopHit.sortOrder", "type": "CompoundType", "tags": [], "label": "sortOrder", "description": [], "signature": [ "\"asc\" | \"desc\" | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig", "type": "Interface", "tags": [], "label": "AggTypeConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggTypeConfig", "text": "AggTypeConfig" }, "" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggTypeConfig.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.createFilter", "type": "Function", "tags": [], "label": "createFilter", "description": [], "signature": [ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggTypeConfig.createFilter.$1", "type": "Uncategorized", "tags": [], "label": "aggConfig", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.createFilter.$2", "type": "Any", "tags": [], "label": "key", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.createFilter.$3", "type": "Any", "tags": [], "label": "params", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.dslName", "type": "string", "tags": [], "label": "dslName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.expressionName", "type": "string", "tags": [], "label": "expressionName", "description": [], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.makeLabel", "type": "CompoundType", "tags": [], "label": "makeLabel", "description": [], "signature": [ "((aggConfig: TAggConfig) => string) | (() => string) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.ordered", "type": "Any", "tags": [], "label": "ordered", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.hasNoDsl", "type": "CompoundType", "tags": [], "label": "hasNoDsl", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.hasNoDslParams", "type": "CompoundType", "tags": [], "label": "hasNoDslParams", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.params", "type": "Array", "tags": [], "label": "params", "description": [], "signature": [ "Partial[] | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.valueType", "type": "CompoundType", "tags": [], "label": "valueType", "description": [], "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getRequestAggs", "type": "CompoundType", "tags": [], "label": "getRequestAggs", "description": [], "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getResponseAggs", "type": "CompoundType", "tags": [], "label": "getResponseAggs", "description": [], "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.customLabels", "type": "CompoundType", "tags": [], "label": "customLabels", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.json", "type": "CompoundType", "tags": [], "label": "json", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.decorateAggConfig", "type": "Function", "tags": [], "label": "decorateAggConfig", "description": [], "signature": [ "(() => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.postFlightRequest", "type": "Function", "tags": [], "label": "postFlightRequest", "description": [], "signature": [ "PostFlightRequestFn | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getSerializedFormat", "type": "Function", "tags": [], "label": "getSerializedFormat", "description": [], "signature": [ "((agg: TAggConfig) => ", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", "section": "def-common.SerializedFieldFormat", "text": "SerializedFieldFormat" }, "<", { "pluginId": "fieldFormats", "scope": "common", "docId": "kibFieldFormatsPluginApi", "section": "def-common.FieldFormatParams", "text": "FieldFormatParams" }, ">) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getSerializedFormat.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getValue", "type": "Function", "tags": [], "label": "getValue", "description": [], "signature": [ "((agg: TAggConfig, bucket: any) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getValue.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getValue.$2", "type": "Any", "tags": [], "label": "bucket", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getKey", "type": "Function", "tags": [], "label": "getKey", "description": [], "signature": [ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getKey.$1", "type": "Any", "tags": [], "label": "bucket", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getKey.$2", "type": "Any", "tags": [], "label": "key", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getKey.$3", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getValueBucketPath", "type": "Function", "tags": [], "label": "getValueBucketPath", "description": [], "signature": [ "((agg: TAggConfig) => string) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggTypeConfig.getValueBucketPath.$1", "type": "Uncategorized", "tags": [], "label": "agg", "description": [], "signature": [ "TAggConfig" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AutoBounds", "type": "Interface", "tags": [], "label": "AutoBounds", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AutoBounds.min", "type": "number", "tags": [], "label": "min", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AutoBounds.max", "type": "number", "tags": [], "label": "max", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.BucketAggParam", "type": "Interface", "tags": [], "label": "BucketAggParam", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggParam", "text": "BucketAggParam" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.BucketAggParam.scriptable", "type": "CompoundType", "tags": [], "label": "scriptable", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.BucketAggParam.filterFieldTypes", "type": "CompoundType", "tags": [], "label": "filterFieldTypes", "description": [], "signature": [ { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, " | \"*\" | ", { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "[] | undefined" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.Cidr", "type": "Interface", "tags": [], "label": "Cidr", "description": [], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.Cidr.mask", "type": "string", "tags": [], "label": "mask", "description": [], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.CidrMaskIpRangeAggKey", "type": "Interface", "tags": [], "label": "CidrMaskIpRangeAggKey", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.CidrMaskIpRangeAggKey.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"mask\"" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.CidrMaskIpRangeAggKey.mask", "type": "string", "tags": [], "label": "mask", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies", "type": "Interface", "tags": [], "label": "DateHistogramBucketAggDependencies", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds", "type": "Function", "tags": [], "label": "calculateBounds", "description": [], "signature": [ "(timeRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRangeBounds", "text": "TimeRangeBounds" } ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds.$1", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone", "type": "Function", "tags": [], "label": "isDefaultTimezone", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string) => T" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.DateHistogramBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.DateRange", "type": "Interface", "tags": [], "label": "DateRange", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.DateRange.from", "type": "CompoundType", "tags": [], "label": "from", "description": [], "signature": [ "string | number" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.DateRange.to", "type": "CompoundType", "tags": [], "label": "to", "description": [], "signature": [ "string | number" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.DateRangeBucketAggDependencies", "type": "Interface", "tags": [], "label": "DateRangeBucketAggDependencies", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone", "type": "Function", "tags": [], "label": "isDefaultTimezone", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.DateRangeBucketAggDependencies.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string) => T" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.DateRangeBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EqlSearchStrategyRequest", "type": "Interface", "tags": [], "label": "EqlSearchStrategyRequest", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EqlSearchStrategyRequest", "text": "EqlSearchStrategyRequest" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, "<", "EqlSearchRequest", ">" ], "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.EqlSearchStrategyRequest.options", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "TransportRequestOptions", " | undefined" ], "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EsRawResponse", "type": "Interface", "tags": [], "label": "EsRawResponse", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsRawResponse", "text": "EsRawResponse" }, "" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.EsRawResponse.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"es_raw_response\"" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.EsRawResponse.body", "type": "Object", "tags": [], "label": "body", "description": [], "signature": [ "SearchResponse", "" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExtendedBounds", "type": "Interface", "tags": [], "label": "ExtendedBounds", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ExtendedBounds.min", "type": "number", "tags": [], "label": "min", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ExtendedBounds.max", "type": "number", "tags": [], "label": "max", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.FetchHandlers", "type": "Interface", "tags": [], "label": "FetchHandlers", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.FetchHandlers.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string, defaultOverride?: T | undefined) => T" ], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.FetchHandlers.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], "path": "src/plugins/data/common/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.FetchHandlers.getConfig.$2", "type": "Uncategorized", "tags": [], "label": "defaultOverride", "description": [], "signature": [ "T | undefined" ], "path": "src/plugins/data/common/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.FetchHandlers.onResponse", "type": "Function", "tags": [], "label": "onResponse", "description": [ "\nCallback which can be used to hook into responses, modify them, or perform\nside effects like displaying UI errors on the client." ], "signature": [ "(request: Record, response: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "" ], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.FetchHandlers.onResponse.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "Record" ], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.FetchHandlers.onResponse.$2", "type": "Object", "tags": [], "label": "response", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "" ], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.FiltersBucketAggDependencies", "type": "Interface", "tags": [], "label": "FiltersBucketAggDependencies", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.FiltersBucketAggDependencies.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string) => any" ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.FiltersBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies", "type": "Interface", "tags": [], "label": "HistogramBucketAggDependencies", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies.getConfig", "type": "Function", "tags": [], "label": "getConfig", "description": [], "signature": [ "(key: string) => T" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", "type": "Function", "tags": [], "label": "getFieldFormatsStart", "description": [], "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IAsyncSearchOptions", "type": "Interface", "tags": [], "label": "IAsyncSearchOptions", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAsyncSearchOptions", "text": "IAsyncSearchOptions" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" } ], "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IAsyncSearchOptions.pollInterval", "type": "number", "tags": [], "label": "pollInterval", "description": [ "\nThe number of milliseconds to wait between receiving a response and sending another request" ], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IBucketAggConfig", "type": "Interface", "tags": [], "label": "IBucketAggConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IBucketAggConfig.type", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IBucketDateHistogramAggConfig", "type": "Interface", "tags": [], "label": "IBucketDateHistogramAggConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketDateHistogramAggConfig", "text": "IBucketDateHistogramAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" } ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IBucketDateHistogramAggConfig.buckets", "type": "Object", "tags": [], "label": "buckets", "description": [], "signature": [ "TimeBuckets" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IBucketHistogramAggConfig", "type": "Interface", "tags": [], "label": "IBucketHistogramAggConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketHistogramAggConfig", "text": "IBucketHistogramAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" } ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IBucketHistogramAggConfig.setAutoBounds", "type": "Function", "tags": [], "label": "setAutoBounds", "description": [], "signature": [ "(bounds: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AutoBounds", "text": "AutoBounds" }, ") => void" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IBucketHistogramAggConfig.setAutoBounds.$1", "type": "Object", "tags": [], "label": "bounds", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AutoBounds", "text": "AutoBounds" } ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.IBucketHistogramAggConfig.getAutoBounds", "type": "Function", "tags": [], "label": "getAutoBounds", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AutoBounds", "text": "AutoBounds" } ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IEsSearchRequest", "type": "Interface", "tags": [], "label": "IEsSearchRequest", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchRequest", "text": "IEsSearchRequest" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchRequestParams", "text": "ISearchRequestParams" }, ">" ], "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IEsSearchRequest.indexType", "type": "string", "tags": [], "label": "indexType", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IInspectorInfo", "type": "Interface", "tags": [], "label": "IInspectorInfo", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IInspectorInfo.adapter", "type": "Object", "tags": [], "label": "adapter", "description": [], "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IInspectorInfo.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IInspectorInfo.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IInspectorInfo.description", "type": "string", "tags": [], "label": "description", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchRequest", "type": "Interface", "tags": [], "label": "IKibanaSearchRequest", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchRequest", "text": "IKibanaSearchRequest" }, "" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IKibanaSearchRequest.id", "type": "string", "tags": [], "label": "id", "description": [ "\nAn id can be used to uniquely identify this request." ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchRequest.params", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse", "type": "Interface", "tags": [], "label": "IKibanaSearchResponse", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.id", "type": "string", "tags": [], "label": "id", "description": [ "\nSome responses may contain a unique id to identify the request this response came from." ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.total", "type": "number", "tags": [], "label": "total", "description": [ "\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated." ], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.loaded", "type": "number", "tags": [], "label": "loaded", "description": [ "\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated." ], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.isRunning", "type": "CompoundType", "tags": [], "label": "isRunning", "description": [ "\nIndicates whether search is still in flight" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.isPartial", "type": "CompoundType", "tags": [], "label": "isPartial", "description": [ "\nIndicates whether the results returned are complete or partial" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.isRestored", "type": "CompoundType", "tags": [], "label": "isRestored", "description": [ "\nIndicates whether the results returned are from the async-search index" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.warning", "type": "string", "tags": [], "label": "warning", "description": [ "\nOptional warnings that should be surfaced to the end user" ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IKibanaSearchResponse.rawResponse", "type": "Uncategorized", "tags": [], "label": "rawResponse", "description": [ "\nThe raw response returned by the internal search method (usually the raw ES response)" ], "signature": [ "RawResponse" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IMetricAggConfig", "type": "Interface", "tags": [], "label": "IMetricAggConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IMetricAggConfig.type", "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IpRange", "type": "Interface", "tags": [], "label": "IpRange", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IpRange.from", "type": "string", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.IpRange.to", "type": "string", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchClient", "type": "Interface", "tags": [], "label": "ISearchClient", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ISearchClient.search", "type": "Function", "tags": [], "label": "search", "description": [], "signature": [ " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchRequest", "text": "IEsSearchRequest" }, ", SearchStrategyResponse extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => ", "Observable", "" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.ISearchClient.search.$1", "type": "Uncategorized", "tags": [], "label": "request", "description": [], "signature": [ "SearchStrategyRequest" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchClient.search.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.ISearchClient.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [ "\nUsed to cancel an in-progress search request." ], "signature": [ "(id: string, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.ISearchClient.cancel.$1", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchClient.cancel.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.ISearchClient.extend", "type": "Function", "tags": [], "label": "extend", "description": [ "\nUsed to extend the TTL of an in-progress search request." ], "signature": [ "(id: string, keepAlive: string, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.ISearchClient.extend.$1", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchClient.extend.$2", "type": "string", "tags": [], "label": "keepAlive", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchClient.extend.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions", "type": "Interface", "tags": [], "label": "ISearchOptions", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ISearchOptions.abortSignal", "type": "Object", "tags": [], "label": "abortSignal", "description": [ "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." ], "signature": [ "AbortSignal | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.strategy", "type": "string", "tags": [], "label": "strategy", "description": [ "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.legacyHitsTotal", "type": "CompoundType", "tags": [], "label": "legacyHitsTotal", "description": [ "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.sessionId", "type": "string", "tags": [], "label": "sessionId", "description": [ "\nA session ID, grouping multiple search requests into a single session." ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.isStored", "type": "CompoundType", "tags": [], "label": "isStored", "description": [ "\nWhether the session is already saved (i.e. sent to background)" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.isRestore", "type": "CompoundType", "tags": [], "label": "isRestore", "description": [ "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.indexPattern", "type": "Object", "tags": [], "label": "indexPattern", "description": [ "\nIndex pattern reference is used for better error messages" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.inspector", "type": "Object", "tags": [], "label": "inspector", "description": [ "\nInspector integration options" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IInspectorInfo", "text": "IInspectorInfo" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptions.executionContext", "type": "Object", "tags": [], "label": "executionContext", "description": [], "signature": [ "KibanaExecutionContext", " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchStartSearchSource", "type": "Interface", "tags": [], "label": "ISearchStartSearchSource", "description": [ "\nhigh level search service" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ISearchStartSearchSource.create", "type": "Function", "tags": [], "label": "create", "description": [ "\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}" ], "signature": [ "(fields?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined) => Promise>" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ISearchStartSearchSource.create.$1", "type": "Object", "tags": [], "label": "fields", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.ISearchStartSearchSource.createEmpty", "type": "Function", "tags": [], "label": "createEmpty", "description": [ "\ncreates empty {@link SearchSource}" ], "signature": [ "() => Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IStdDevAggConfig", "type": "Interface", "tags": [], "label": "IStdDevAggConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IStdDevAggConfig", "text": "IStdDevAggConfig" }, " extends ", "IResponseAggConfig" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IStdDevAggConfig.keyedDetails", "type": "Function", "tags": [], "label": "keyedDetails", "description": [], "signature": [ "(customLabel: string, fieldDisplayName?: string | undefined) => Record" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.IStdDevAggConfig.keyedDetails.$1", "type": "string", "tags": [], "label": "customLabel", "description": [], "signature": [ "string" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.IStdDevAggConfig.keyedDetails.$2", "type": "string", "tags": [], "label": "fieldDisplayName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.IStdDevAggConfig.valProp", "type": "Function", "tags": [], "label": "valProp", "description": [], "signature": [ "() => string[]" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.MetricAggParam", "type": "Interface", "tags": [], "label": "MetricAggParam", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggParam", "text": "MetricAggParam" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.MetricAggParam.filterFieldTypes", "type": "CompoundType", "tags": [], "label": "filterFieldTypes", "description": [], "signature": [ { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, " | \"*\" | ", { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "[] | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.MetricAggParam.onlyAggregatable", "type": "CompoundType", "tags": [], "label": "onlyAggregatable", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.NumericalRange", "type": "Interface", "tags": [], "label": "NumericalRange", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.NumericalRange.from", "type": "number", "tags": [], "label": "from", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.NumericalRange.to", "type": "number", "tags": [], "label": "to", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.NumericalRange.label", "type": "string", "tags": [], "label": "label", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.OptionedValueProp", "type": "Interface", "tags": [], "label": "OptionedValueProp", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.OptionedValueProp.value", "type": "string", "tags": [], "label": "value", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.OptionedValueProp.text", "type": "string", "tags": [], "label": "text", "description": [], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.OptionedValueProp.disabled", "type": "CompoundType", "tags": [], "label": "disabled", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.OptionedValueProp.isCompatible", "type": "Function", "tags": [], "label": "isCompatible", "description": [], "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ") => boolean" ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.OptionedValueProp.isCompatible.$1", "type": "Object", "tags": [], "label": "agg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.PercentileRanksMetricAggDependencies", "type": "Interface", "tags": [], "label": "PercentileRanksMetricAggDependencies", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart", "type": "Function", "tags": [], "label": "getFieldFormatsStart", "description": [], "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.QueryFilter", "type": "Interface", "tags": [], "label": "QueryFilter", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.QueryFilter.input", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ "{ query: string | { [key: string]: any; }; language: string; }" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.QueryFilter.label", "type": "string", "tags": [], "label": "label", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.RangeBucketAggDependencies", "type": "Interface", "tags": [], "label": "RangeBucketAggDependencies", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.RangeBucketAggDependencies.getFieldFormatsStart", "type": "Function", "tags": [], "label": "getFieldFormatsStart", "description": [], "signature": [ "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ], "path": "src/plugins/data/common/search/aggs/buckets/range.ts", "deprecated": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey", "type": "Interface", "tags": [], "label": "RangeIpRangeAggKey", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"range\"" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey.from", "type": "string", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.RangeIpRangeAggKey.to", "type": "string", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.Request", "type": "Interface", "tags": [], "label": "Request", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.Request.docvalue_fields", "type": "Array", "tags": [], "label": "docvalue_fields", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.Request._source", "type": "Unknown", "tags": [], "label": "_source", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.Request.query", "type": "Unknown", "tags": [], "label": "query", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.Request.script_fields", "type": "Unknown", "tags": [], "label": "script_fields", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.Request.sort", "type": "Unknown", "tags": [], "label": "sort", "description": [], "signature": [ "unknown" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.Request.stored_fields", "type": "Array", "tags": [], "label": "stored_fields", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ResponseWithShardFailure", "type": "Interface", "tags": [], "label": "ResponseWithShardFailure", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ResponseWithShardFailure._shards", "type": "Object", "tags": [], "label": "_shards", "description": [], "signature": [ "{ failed: number; failures: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ShardFailure", "text": "ShardFailure" }, "[]; skipped: number; successful: number; total: number; }" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchError", "type": "Interface", "tags": [], "label": "SearchError", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchError.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchError.status", "type": "string", "tags": [], "label": "status", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchError.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchError.message", "type": "string", "tags": [], "label": "message", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchError.path", "type": "string", "tags": [], "label": "path", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchError.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions", "type": "Interface", "tags": [], "label": "SearchSessionFindOptions", "description": [], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.page", "type": "number", "tags": [], "label": "page", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.perPage", "type": "number", "tags": [], "label": "perPage", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.sortField", "type": "string", "tags": [], "label": "sortField", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.sortOrder", "type": "string", "tags": [], "label": "sortOrder", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionFindOptions.filter", "type": "string", "tags": [], "label": "filter", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo", "type": "Interface", "tags": [], "label": "SearchSessionRequestInfo", "description": [], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.id", "type": "string", "tags": [], "label": "id", "description": [ "\nID of the async search request" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.strategy", "type": "string", "tags": [], "label": "strategy", "description": [ "\nSearch strategy used to submit the search request" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.status", "type": "string", "tags": [], "label": "status", "description": [ "\nstatus" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionRequestInfo.error", "type": "string", "tags": [], "label": "error", "description": [ "\nAn optional error. Set if status is set to error." ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes", "type": "Interface", "tags": [], "label": "SearchSessionSavedObjectAttributes", "description": [], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.sessionId", "type": "string", "tags": [], "label": "sessionId", "description": [], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.name", "type": "string", "tags": [], "label": "name", "description": [ "\nUser-facing session name to be displayed in session management" ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.appId", "type": "string", "tags": [], "label": "appId", "description": [ "\nApp that created the session. e.g 'discover'" ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.created", "type": "string", "tags": [], "label": "created", "description": [ "\nCreation time of the session" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.touched", "type": "string", "tags": [], "label": "touched", "description": [ "\nLast touch time of the session" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.expires", "type": "string", "tags": [], "label": "expires", "description": [ "\nExpiration time of the session. Expiration itself is managed by Elasticsearch." ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.completed", "type": "CompoundType", "tags": [], "label": "completed", "description": [ "\nTime of transition into completed state,\n\nCan be \"null\" in case already completed session\ntransitioned into in-progress session" ], "signature": [ "string | null | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.status", "type": "Enum", "tags": [], "label": "status", "description": [ "\nstatus" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionStatus", "text": "SearchSessionStatus" } ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.locatorId", "type": "string", "tags": [], "label": "locatorId", "description": [ "\nlocatorId (see share.url.locators service)" ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.initialState", "type": "Object", "tags": [], "label": "initialState", "description": [ "\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session." ], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.restoreState", "type": "Object", "tags": [], "label": "restoreState", "description": [ "\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones." ], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.idMapping", "type": "Object", "tags": [], "label": "idMapping", "description": [ "\nMapping of search request hashes to their corresponsing info (async search id, etc.)" ], "signature": [ "{ [x: string]: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSessionRequestInfo", "text": "SearchSessionRequestInfo" }, "; }" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.persisted", "type": "boolean", "tags": [], "label": "persisted", "description": [ "\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system." ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.realmType", "type": "string", "tags": [], "label": "realmType", "description": [ "\nThe realm type/name & username uniquely identifies the user who created this search session" ], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.realmName", "type": "string", "tags": [], "label": "realmName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.username", "type": "string", "tags": [], "label": "username", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionSavedObjectAttributes.version", "type": "string", "tags": [], "label": "version", "description": [ "\nVersion information to display warnings when trying to restore a session from a different version" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceDependencies", "type": "Interface", "tags": [], "label": "SearchSourceDependencies", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceDependencies", "text": "SearchSourceDependencies" }, " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FetchHandlers", "text": "FetchHandlers" } ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSourceDependencies.search", "type": "Function", "tags": [], "label": "search", "description": [], "signature": [ " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchRequest", "text": "IEsSearchRequest" }, ", SearchStrategyResponse extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => ", "Observable", "" ], "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.SearchSourceDependencies.search.$1", "type": "Uncategorized", "tags": [], "label": "request", "description": [], "signature": [ "SearchStrategyRequest" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceDependencies.search.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields", "type": "Interface", "tags": [], "label": "SearchSourceFields", "description": [ "\nsearch source fields" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSourceFields.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.query", "type": "Object", "tags": [], "label": "query", "description": [ "\n{@link Query}" ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.filter", "type": "CompoundType", "tags": [], "label": "filter", "description": [ "\n{@link Filter}" ], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | (() => ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined) | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.sort", "type": "CompoundType", "tags": [], "label": "sort", "description": [ "\n{@link EsQuerySortValue}" ], "signature": [ "Record | Record[] | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.highlight", "type": "Any", "tags": [], "label": "highlight", "description": [], "signature": [ "any" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.highlightAll", "type": "CompoundType", "tags": [], "label": "highlightAll", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.trackTotalHits", "type": "CompoundType", "tags": [], "label": "trackTotalHits", "description": [], "signature": [ "number | boolean | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.aggs", "type": "CompoundType", "tags": [], "label": "aggs", "description": [ "\n{@link AggConfigs}" ], "signature": [ "object | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | (() => object) | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.from", "type": "number", "tags": [], "label": "from", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.size", "type": "number", "tags": [], "label": "size", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.source", "type": "CompoundType", "tags": [], "label": "source", "description": [], "signature": [ "string | boolean | string[] | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.version", "type": "CompoundType", "tags": [], "label": "version", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.fields", "type": "Array", "tags": [], "label": "fields", "description": [ "\nRetrieve fields via the search Fields API" ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchFieldValue", "text": "SearchFieldValue" }, "[] | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.fieldsFromSource", "type": "CompoundType", "tags": [ "deprecated" ], "label": "fieldsFromSource", "description": [ "\nRetreive fields directly from _source (legacy behavior)\n" ], "signature": [ "string | string[] | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": true, "references": [ { "plugin": "reporting", "path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts" }, { "plugin": "reporting", "path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts" } ] }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.index", "type": "Object", "tags": [], "label": "index", "description": [ "\n{@link IndexPatternService}" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.searchAfter", "type": "Object", "tags": [], "label": "searchAfter", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsQuerySearchAfter", "text": "EsQuerySearchAfter" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.timeout", "type": "string", "tags": [], "label": "timeout", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.terminate_after", "type": "number", "tags": [], "label": "terminate_after", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceFields.parent", "type": "Object", "tags": [], "label": "parent", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSourceOptions", "type": "Interface", "tags": [], "label": "SearchSourceOptions", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SearchSourceOptions.callParentStartHandlers", "type": "CompoundType", "tags": [], "label": "callParentStartHandlers", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ShardFailure", "type": "Interface", "tags": [], "label": "ShardFailure", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ShardFailure.index", "type": "string", "tags": [], "label": "index", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ShardFailure.node", "type": "string", "tags": [], "label": "node", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ShardFailure.reason", "type": "Object", "tags": [], "label": "reason", "description": [], "signature": [ "{ caused_by: { reason: string; type: string; }; reason: string; lang?: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ShardFailure.shard", "type": "number", "tags": [], "label": "shard", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SortDirectionFormat", "type": "Interface", "tags": [], "label": "SortDirectionFormat", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SortDirectionFormat.order", "type": "Enum", "tags": [], "label": "order", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirection", "text": "SortDirection" } ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortDirectionFormat.format", "type": "string", "tags": [], "label": "format", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SortDirectionNumeric", "type": "Interface", "tags": [], "label": "SortDirectionNumeric", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SortDirectionNumeric.order", "type": "Enum", "tags": [], "label": "order", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirection", "text": "SortDirection" } ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortDirectionNumeric.numeric_type", "type": "CompoundType", "tags": [], "label": "numeric_type", "description": [], "signature": [ "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SortOptions", "type": "Interface", "tags": [], "label": "SortOptions", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.SortOptions.mode", "type": "CompoundType", "tags": [], "label": "mode", "description": [], "signature": [ "\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortOptions.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortOptions.nested", "type": "Uncategorized", "tags": [], "label": "nested", "description": [], "signature": [ "object | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortOptions.unmapped_type", "type": "string", "tags": [], "label": "unmapped_type", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortOptions.distance_type", "type": "CompoundType", "tags": [], "label": "distance_type", "description": [], "signature": [ "\"arc\" | \"plane\" | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortOptions.unit", "type": "string", "tags": [], "label": "unit", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortOptions.ignore_unmapped", "type": "CompoundType", "tags": [], "label": "ignore_unmapped", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.SortOptions._script", "type": "Uncategorized", "tags": [], "label": "_script", "description": [], "signature": [ "object | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "data", "id": "def-common.BUCKET_TYPES", "type": "Enum", "tags": [], "label": "BUCKET_TYPES", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IP_RANGE_TYPES", "type": "Enum", "tags": [], "label": "IP_RANGE_TYPES", "description": [], "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.METRIC_TYPES", "type": "Enum", "tags": [], "label": "METRIC_TYPES", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchSessionStatus", "type": "Enum", "tags": [], "label": "SearchSessionStatus", "description": [], "path": "src/plugins/data/common/search/session/status.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SortDirection", "type": "Enum", "tags": [], "label": "SortDirection", "description": [], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "data", "id": "def-common.aggAvgFnName", "type": "string", "tags": [], "label": "aggAvgFnName", "description": [], "signature": [ "\"aggAvg\"" ], "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketAvgFnName", "type": "string", "tags": [], "label": "aggBucketAvgFnName", "description": [], "signature": [ "\"aggBucketAvg\"" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketMaxFnName", "type": "string", "tags": [], "label": "aggBucketMaxFnName", "description": [], "signature": [ "\"aggBucketMax\"" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketMinFnName", "type": "string", "tags": [], "label": "aggBucketMinFnName", "description": [], "signature": [ "\"aggBucketMin\"" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggBucketSumFnName", "type": "string", "tags": [], "label": "aggBucketSumFnName", "description": [], "signature": [ "\"aggBucketSum\"" ], "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggCardinalityFnName", "type": "string", "tags": [], "label": "aggCardinalityFnName", "description": [], "signature": [ "\"aggCardinality\"" ], "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggConfigOptions", "type": "Type", "tags": [], "label": "AggConfigOptions", "description": [], "signature": [ "{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggConfigSerialized", "type": "Type", "tags": [], "label": "AggConfigSerialized", "description": [], "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggCountFnName", "type": "string", "tags": [], "label": "aggCountFnName", "description": [], "signature": [ "\"aggCount\"" ], "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggCumulativeSumFnName", "type": "string", "tags": [], "label": "aggCumulativeSumFnName", "description": [], "signature": [ "\"aggCumulativeSum\"" ], "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggDateHistogramFnName", "type": "string", "tags": [], "label": "aggDateHistogramFnName", "description": [], "signature": [ "\"aggDateHistogram\"" ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggDateRangeFnName", "type": "string", "tags": [], "label": "aggDateRangeFnName", "description": [], "signature": [ "\"aggDateRange\"" ], "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggDerivativeFnName", "type": "string", "tags": [], "label": "aggDerivativeFnName", "description": [], "signature": [ "\"aggDerivative\"" ], "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggFilteredMetricFnName", "type": "string", "tags": [], "label": "aggFilteredMetricFnName", "description": [], "signature": [ "\"aggFilteredMetric\"" ], "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggFilterFnName", "type": "string", "tags": [], "label": "aggFilterFnName", "description": [], "signature": [ "\"aggFilter\"" ], "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggFiltersFnName", "type": "string", "tags": [], "label": "aggFiltersFnName", "description": [], "signature": [ "\"aggFilters\"" ], "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoBoundsFnName", "type": "string", "tags": [], "label": "aggGeoBoundsFnName", "description": [], "signature": [ "\"aggGeoBounds\"" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoCentroidFnName", "type": "string", "tags": [], "label": "aggGeoCentroidFnName", "description": [], "signature": [ "\"aggGeoCentroid\"" ], "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoHashFnName", "type": "string", "tags": [], "label": "aggGeoHashFnName", "description": [], "signature": [ "\"aggGeoHash\"" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggGeoTileFnName", "type": "string", "tags": [], "label": "aggGeoTileFnName", "description": [], "signature": [ "\"aggGeoTile\"" ], "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggGroupName", "type": "Type", "tags": [], "label": "AggGroupName", "description": [], "signature": [ "\"none\" | \"buckets\" | \"metrics\"" ], "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggHistogramFnName", "type": "string", "tags": [], "label": "aggHistogramFnName", "description": [], "signature": [ "\"aggHistogram\"" ], "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggIpRangeFnName", "type": "string", "tags": [], "label": "aggIpRangeFnName", "description": [], "signature": [ "\"aggIpRange\"" ], "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMaxFnName", "type": "string", "tags": [], "label": "aggMaxFnName", "description": [], "signature": [ "\"aggMax\"" ], "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMedianFnName", "type": "string", "tags": [], "label": "aggMedianFnName", "description": [], "signature": [ "\"aggMedian\"" ], "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMinFnName", "type": "string", "tags": [], "label": "aggMinFnName", "description": [], "signature": [ "\"aggMin\"" ], "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggMovingAvgFnName", "type": "string", "tags": [], "label": "aggMovingAvgFnName", "description": [], "signature": [ "\"aggMovingAvg\"" ], "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggParam", "type": "Type", "tags": [], "label": "AggParam", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BaseParamType", "text": "BaseParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/agg_params.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggPercentileRanksFnName", "type": "string", "tags": [], "label": "aggPercentileRanksFnName", "description": [], "signature": [ "\"aggPercentileRanks\"" ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggPercentilesFnName", "type": "string", "tags": [], "label": "aggPercentilesFnName", "description": [], "signature": [ "\"aggPercentiles\"" ], "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggRangeFnName", "type": "string", "tags": [], "label": "aggRangeFnName", "description": [], "signature": [ "\"aggRange\"" ], "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSerialDiffFnName", "type": "string", "tags": [], "label": "aggSerialDiffFnName", "description": [], "signature": [ "\"aggSerialDiff\"" ], "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSignificantTermsFnName", "type": "string", "tags": [], "label": "aggSignificantTermsFnName", "description": [], "signature": [ "\"aggSignificantTerms\"" ], "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSinglePercentileFnName", "type": "string", "tags": [], "label": "aggSinglePercentileFnName", "description": [], "signature": [ "\"aggSinglePercentile\"" ], "path": "src/plugins/data/common/search/aggs/metrics/single_percentile_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggsStart", "type": "Type", "tags": [], "label": "AggsStart", "description": [ "\nAggsStart represents the actual external contract as AggsCommonStart\nis only used internally. The difference is that AggsStart includes the\ntypings for the registry with initialized agg types.\n" ], "signature": [ "{ calculateAutoTimeExpression: (range: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => string | undefined; datatableUtilities: { getIndexPattern: (column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => Promise<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined>; getAggConfig: (column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, " | undefined>; isFilterable: (column: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, ") => boolean; }; createAggConfigs: (indexPattern: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, ", configStates?: Pick & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"id\" | \"enabled\" | \"schema\" | \"params\">[] | undefined) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, "; types: ", "AggTypesRegistryStart", "; }" ], "path": "src/plugins/data/common/search/aggs/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggStdDeviationFnName", "type": "string", "tags": [], "label": "aggStdDeviationFnName", "description": [], "signature": [ "\"aggStdDeviation\"" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggSumFnName", "type": "string", "tags": [], "label": "aggSumFnName", "description": [], "signature": [ "\"aggSum\"" ], "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggTermsFnName", "type": "string", "tags": [], "label": "aggTermsFnName", "description": [], "signature": [ "\"aggTerms\"" ], "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.aggTopHitFnName", "type": "string", "tags": [], "label": "aggTopHitFnName", "description": [], "signature": [ "\"aggTopHit\"" ], "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggTypesRegistrySetup", "type": "Type", "tags": [], "label": "AggTypesRegistrySetup", "description": [], "signature": [ "{ registerBucket: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.BucketAggType", "text": "BucketAggType" }, ">(name: N, type: T) => void; registerMetric: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, ">(name: N, type: T) => void; }" ], "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.autoInterval", "type": "string", "tags": [], "label": "autoInterval", "description": [], "signature": [ "\"auto\"" ], "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.boundsDescendingRaw", "type": "Array", "tags": [], "label": "boundsDescendingRaw", "description": [], "signature": [ "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" ], "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.CidrOutput", "type": "Type", "tags": [], "label": "CidrOutput", "description": [], "signature": [ "{ type: \"cidr\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" } ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.CreateAggConfigParams", "type": "Type", "tags": [], "label": "CreateAggConfigParams", "description": [], "signature": [ "{ type: string | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.DateRangeOutput", "type": "Type", "tags": [], "label": "DateRangeOutput", "description": [], "signature": [ "{ type: \"date_range\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" } ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ENHANCED_ES_SEARCH_STRATEGY", "type": "string", "tags": [], "label": "ENHANCED_ES_SEARCH_STRATEGY", "description": [], "signature": [ "\"ese\"" ], "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EQL_SEARCH_STRATEGY", "type": "string", "tags": [], "label": "EQL_SEARCH_STRATEGY", "description": [], "signature": [ "\"eql\"" ], "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EqlRequestParams", "type": "Type", "tags": [], "label": "EqlRequestParams", "description": [], "signature": [ "EqlSearchRequest" ], "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EqlSearchStrategyResponse", "type": "Type", "tags": [], "label": "EqlSearchStrategyResponse", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", "TransportResult", ">" ], "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ES_SEARCH_STRATEGY", "type": "string", "tags": [], "label": "ES_SEARCH_STRATEGY", "description": [], "signature": [ "\"es\"" ], "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EsaggsExpressionFunctionDefinition", "type": "Type", "tags": [], "label": "EsaggsExpressionFunctionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"esaggs\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EsdslExpressionFunctionDefinition", "type": "Type", "tags": [], "label": "EsdslExpressionFunctionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"esdsl\", Input, Arguments, Output, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/esdsl.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EsQuerySearchAfter", "type": "Type", "tags": [], "label": "EsQuerySearchAfter", "description": [], "signature": [ "[React.ReactText, React.ReactText]" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EsQuerySortValue", "type": "Type", "tags": [], "label": "EsQuerySortValue", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirection", "text": "SortDirection" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirectionNumeric", "text": "SortDirectionNumeric" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirectionFormat", "text": "SortDirectionFormat" }, "; }" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.EsRawResponseExpressionTypeDefinition", "type": "Type", "tags": [], "label": "EsRawResponseExpressionTypeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeDefinition", "text": "ExpressionTypeDefinition" }, "<\"es_raw_response\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsRawResponse", "text": "EsRawResponse" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsRawResponse", "text": "EsRawResponse" }, ">" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExecutionContextSearch", "type": "Type", "tags": [], "label": "ExecutionContextSearch", "description": [], "signature": [ "{ filters?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, "[] | undefined; timeRange?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined; }" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionCidr", "type": "Type", "tags": [], "label": "ExpressionFunctionCidr", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"cidr\", null, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"cidr\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionDateRange", "type": "Type", "tags": [], "label": "ExpressionFunctionDateRange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"dateRange\", null, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"date_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionExistsFilter", "type": "Type", "tags": [], "label": "ExpressionFunctionExistsFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"existsFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_filter\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionExtendedBounds", "type": "Type", "tags": [], "label": "ExpressionFunctionExtendedBounds", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"extendedBounds\", null, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"extended_bounds\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionField", "type": "Type", "tags": [], "label": "ExpressionFunctionField", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"field\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_field\", ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPatternField", "text": "IndexPatternField" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionGeoBoundingBox", "type": "Type", "tags": [], "label": "ExpressionFunctionGeoBoundingBox", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"geoBoundingBox\", null, GeoBoundingBoxArguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"geo_bounding_box\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoBoundingBox", "text": "GeoBoundingBox" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionGeoPoint", "type": "Type", "tags": [], "label": "ExpressionFunctionGeoPoint", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"geoPoint\", null, GeoPointArguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"geo_point\", { value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }>, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionIpRange", "type": "Type", "tags": [], "label": "ExpressionFunctionIpRange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"ipRange\", null, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"ip_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibana", "type": "Type", "tags": [], "label": "ExpressionFunctionKibana", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"kibana\", Input, object, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">>" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibanaContext", "type": "Type", "tags": [], "label": "ExpressionFunctionKibanaContext", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"kibana_context\", Input, Arguments, Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">>, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">>" ], "path": "src/plugins/data/common/search/expressions/kibana_context.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibanaFilter", "type": "Type", "tags": [], "label": "ExpressionFunctionKibanaFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"kibanaFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_filter\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionKibanaTimerange", "type": "Type", "tags": [], "label": "ExpressionFunctionKibanaTimerange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"timerange\", null, ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"timerange\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionKql", "type": "Type", "tags": [], "label": "ExpressionFunctionKql", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"kql\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionLucene", "type": "Type", "tags": [], "label": "ExpressionFunctionLucene", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"lucene\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionNumericalRange", "type": "Type", "tags": [], "label": "ExpressionFunctionNumericalRange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"numericalRange\", null, ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"numerical_range\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionPhraseFilter", "type": "Type", "tags": [], "label": "ExpressionFunctionPhraseFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"rangeFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_filter\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionQueryFilter", "type": "Type", "tags": [], "label": "ExpressionFunctionQueryFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"queryFilter\", null, QueryFilterArguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query_filter\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionRange", "type": "Type", "tags": [], "label": "ExpressionFunctionRange", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"range\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_range\", Arguments>, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionRangeFilter", "type": "Type", "tags": [], "label": "ExpressionFunctionRangeFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"rangeFilter\", null, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_filter\", ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionRemoveFilter", "type": "Type", "tags": [], "label": "ExpressionFunctionRemoveFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"removeFilter\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionFunctionSelectFilter", "type": "Type", "tags": [], "label": "ExpressionFunctionSelectFilter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"selectFilter\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">, Arguments, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ">>" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExpressionValueSearchContext", "type": "Type", "tags": [], "label": "ExpressionValueSearchContext", "description": [], "signature": [ "{ type: \"kibana_context\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" } ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ExtendedBoundsOutput", "type": "Type", "tags": [], "label": "ExtendedBoundsOutput", "description": [], "signature": [ "{ type: \"extended_bounds\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" } ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.FieldTypes", "type": "Type", "tags": [], "label": "FieldTypes", "description": [], "signature": [ { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, " | \"*\" | ", { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "[]" ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.GenericBucket", "type": "Type", "tags": [], "label": "GenericBucket", "description": [], "signature": [ "(", "AggregationsCompositeBucketKeys", " & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | (", "AggregationsDateHistogramBucketKeys", " & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | (", "AggregationsFiltersBucketItemKeys", " & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | (", "AggregationsIpRangeBucketKeys", " & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | (", "AggregationsRangeBucketKeys", " & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | (", "AggregationsRareTermsBucketKeys", " & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | (", "AggregationsSignificantTermsBucketKeys", " & { [property: string]: ", "AggregationsAggregate", "; }) | ({ [property: string]: ", "AggregationsAggregate", "; } & { [property: string]: ", "AggregationsAggregate", "; }) | (", "AggregationsKeyedBucketKeys", " & { [property: string]: ", "AggregationsAggregate", "; })" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.GeoBoundingBox", "type": "Type", "tags": [], "label": "GeoBoundingBox", "description": [ "GeoBoundingBox Accepted Formats:\n Lat Lon As Properties:\n \"top_left\" : {\n \"lat\" : 40.73, \"lon\" : -74.1\n },\n \"bottom_right\" : {\n \"lat\" : 40.01, \"lon\" : -71.12\n }\n\n Lat Lon As Array:\n {\n \"top_left\" : [-74.1, 40.73],\n \"bottom_right\" : [-71.12, 40.01]\n }\n\n Lat Lon As String:\n {\n \"top_left\" : \"40.73, -74.1\",\n \"bottom_right\" : \"40.01, -71.12\"\n }\n\n Bounding Box as Well-Known Text (WKT):\n {\n \"wkt\" : \"BBOX (-74.1, -71.12, 40.73, 40.01)\"\n }\n\n Geohash:\n {\n \"top_right\" : \"dr5r9ydj2y73\",\n \"bottom_left\" : \"drj7teegpus6\"\n }\n\n Vertices:\n {\n \"top\" : 40.73,\n \"left\" : -74.1,\n \"bottom\" : 40.01,\n \"right\" : -71.12\n }\n" ], "signature": [ "GeoBox | { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; } | { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; } | WellKnownText" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.GeoBoundingBoxOutput", "type": "Type", "tags": [], "label": "GeoBoundingBoxOutput", "description": [], "signature": [ "({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & { top_right: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; bottom_left: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText)" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.GeoPoint", "type": "Type", "tags": [], "label": "GeoPoint", "description": [], "signature": [ "string | [number, number] | Point" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.GeoPointOutput", "type": "Type", "tags": [], "label": "GeoPointOutput", "description": [], "signature": [ "{ type: \"geo_point\"; } & { value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IAggConfig", "type": "Type", "tags": [ "name", "description" ], "label": "IAggConfig", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" } ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IAggType", "type": "Type", "tags": [], "label": "IAggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggType", "text": "AggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParamType", "text": "AggParamType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfig", "text": "AggConfig" }, ">>" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IEsSearchResponse", "type": "Type", "tags": [], "label": "IEsSearchResponse", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", "SearchResponse", ">" ], "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IFieldParamType", "type": "Type", "tags": [], "label": "IFieldParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.FieldParamType", "text": "FieldParamType" } ], "path": "src/plugins/data/common/search/aggs/param_types/field.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IMetricAggType", "type": "Type", "tags": [], "label": "IMetricAggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggType", "text": "MetricAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">" ], "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.intervalOptions", "type": "Array", "tags": [], "label": "intervalOptions", "description": [], "signature": [ "({ display: string; val: string; enabled(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, "): boolean; } | { display: string; val: string; })[]" ], "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IPercentileAggConfig", "type": "Type", "tags": [], "label": "IPercentileAggConfig", "description": [], "signature": [ "IResponseAggConfig" ], "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IPercentileRanksAggConfig", "type": "Type", "tags": [], "label": "IPercentileRanksAggConfig", "description": [], "signature": [ "IResponseAggConfig" ], "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IpRangeKey", "type": "Type", "tags": [], "label": "IpRangeKey", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.CidrMaskIpRangeAggKey", "text": "CidrMaskIpRangeAggKey" }, " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.RangeIpRangeAggKey", "text": "RangeIpRangeAggKey" } ], "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.IpRangeOutput", "type": "Type", "tags": [], "label": "IpRangeOutput", "description": [], "signature": [ "{ type: \"ip_range\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" } ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchCancelGeneric", "type": "Type", "tags": [], "label": "ISearchCancelGeneric", "description": [], "signature": [ "(id: string, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.ISearchCancelGeneric.$1", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchCancelGeneric.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchExtendGeneric", "type": "Type", "tags": [], "label": "ISearchExtendGeneric", "description": [], "signature": [ "(id: string, keepAlive: string, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.ISearchExtendGeneric.$1", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchExtendGeneric.$2", "type": "string", "tags": [], "label": "keepAlive", "description": [], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchExtendGeneric.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchGeneric", "type": "Type", "tags": [], "label": "ISearchGeneric", "description": [], "signature": [ " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchRequest", "text": "IEsSearchRequest" }, ", SearchStrategyResponse extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, " = ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IEsSearchResponse", "text": "IEsSearchResponse" }, ">(request: SearchStrategyRequest, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => ", "Observable", "" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "data", "id": "def-common.ISearchGeneric.$1", "type": "Uncategorized", "tags": [], "label": "request", "description": [], "signature": [ "SearchStrategyRequest" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ISearchGeneric.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchOptionsSerializable", "type": "Type", "tags": [], "label": "ISearchOptionsSerializable", "description": [ "\nSame as `ISearchOptions`, but contains only serializable fields, which can\nbe sent over the network." ], "signature": [ "{ executionContext?: ", "KibanaExecutionContext", " | undefined; isStored?: boolean | undefined; isRestore?: boolean | undefined; sessionId?: string | undefined; strategy?: string | undefined; legacyHitsTotal?: boolean | undefined; }" ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchRequestParams", "type": "Type", "tags": [], "label": "ISearchRequestParams", "description": [], "signature": [ "{ trackTotalHits?: boolean | undefined; } & ", "SearchRequest" ], "path": "src/plugins/data/common/search/strategies/es_search/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ISearchSource", "type": "Type", "tags": [], "label": "ISearchSource", "description": [ "\nsearch source interface" ], "signature": [ "{ create: () => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, "; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (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" }, "; removeField: (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: (field: K, recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "[K]; getOwnField: (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?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | 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$: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => ", "Observable", "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IKibanaSearchResponse", "text": "IKibanaSearchResponse" }, "<", "SearchResponse", ">>; fetch: (options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, ") => Promise<", "SearchResponse", ">; 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.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => Promise) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, "; serialize: () => { searchSourceJSON: string; references: ", "SavedObjectReference", "[]; }; }" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.KIBANA_CONTEXT_NAME", "type": "Type", "tags": [], "label": "KIBANA_CONTEXT_NAME", "description": [], "signature": [ "\"kibana_context\"" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.KibanaContext", "type": "Type", "tags": [], "label": "KibanaContext", "description": [], "signature": [ "{ type: \"kibana_context\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" } ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.KibanaField", "type": "Type", "tags": [], "label": "KibanaField", "description": [], "signature": [ "{ type: \"kibana_field\"; } & ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPatternField", "text": "IndexPatternField" } ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.KibanaFilter", "type": "Type", "tags": [], "label": "KibanaFilter", "description": [], "signature": [ "{ type: \"kibana_filter\"; } & ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" } ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.KibanaQueryOutput", "type": "Type", "tags": [], "label": "KibanaQueryOutput", "description": [], "signature": [ "{ type: \"kibana_query\"; } & ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" } ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.KibanaRange", "type": "Type", "tags": [], "label": "KibanaRange", "description": [], "signature": [ "{ type: \"kibana_range\"; } & Arguments" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.KibanaTimerangeOutput", "type": "Type", "tags": [], "label": "KibanaTimerangeOutput", "description": [], "signature": [ "{ type: \"timerange\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.NumericalRangeOutput", "type": "Type", "tags": [], "label": "NumericalRangeOutput", "description": [], "signature": [ "{ type: \"numerical_range\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" } ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.parentPipelineType", "type": "string", "tags": [], "label": "parentPipelineType", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ParsedInterval", "type": "Type", "tags": [], "label": "ParsedInterval", "description": [], "signature": [ "{ value: number; unit: ", { "pluginId": "@elastic/datemath", "scope": "server", "docId": "kibElasticDatemathPluginApi", "section": "def-server.Unit", "text": "Unit" }, "; type: \"calendar\" | \"fixed\"; }" ], "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.QueryFilterOutput", "type": "Type", "tags": [], "label": "QueryFilterOutput", "description": [], "signature": [ "{ type: \"kibana_query_filter\"; } & ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" } ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SEARCH_SESSION_TYPE", "type": "string", "tags": [], "label": "SEARCH_SESSION_TYPE", "description": [], "signature": [ "\"search-session\"" ], "path": "src/plugins/data/common/search/session/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SEARCH_SESSIONS_TABLE_ID", "type": "string", "tags": [], "label": "SEARCH_SESSIONS_TABLE_ID", "description": [], "signature": [ "\"searchSessionsMgmtUiTable\"" ], "path": "src/plugins/data/common/search/session/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.SearchFieldValue", "type": "Type", "tags": [], "label": "SearchFieldValue", "description": [], "signature": [ "string | SearchField" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.siblingPipelineType", "type": "string", "tags": [], "label": "siblingPipelineType", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.termsAggFilter", "type": "Array", "tags": [], "label": "termsAggFilter", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "data", "id": "def-common.AggGroupLabels", "type": "Object", "tags": [], "label": "AggGroupLabels", "description": [], "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Buckets", "type": "string", "tags": [], "label": "[AggGroupNames.Buckets]", "description": [], "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.Metrics", "type": "string", "tags": [], "label": "[AggGroupNames.Metrics]", "description": [], "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.AggGroupLabels.AggGroupNames.None", "type": "string", "tags": [], "label": "[AggGroupNames.None]", "description": [], "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.AggGroupNames", "type": "Object", "tags": [], "label": "AggGroupNames", "description": [], "signature": [ "{ readonly Buckets: \"buckets\"; readonly Metrics: \"metrics\"; readonly None: \"none\"; }" ], "path": "src/plugins/data/common/search/aggs/agg_groups.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.cidrFunction", "type": "Object", "tags": [], "label": "cidrFunction", "description": [], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.cidrFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"cidr\"" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.cidrFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"cidr\"" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.cidrFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.cidrFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.cidrFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.cidrFunction.args.mask", "type": "Object", "tags": [], "label": "mask", "description": [], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.cidrFunction.args.mask.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.cidrFunction.args.mask.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.cidrFunction.args.mask.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.cidrFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, { mask }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" }, ") => { mask: string; type: \"cidr\"; }" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.cidrFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.cidrFunction.fn.$2", "type": "Object", "tags": [], "label": "{ mask }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.Cidr", "text": "Cidr" } ], "path": "src/plugins/data/common/search/expressions/cidr.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction", "type": "Object", "tags": [], "label": "dateRangeFunction", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.dateRangeFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"dateRange\"" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"date_range\"" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.dateRangeFunction.args.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.dateRangeFunction.args.from.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"string\")[]" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.args.from.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.args.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.dateRangeFunction.args.to.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"string\")[]" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.args.to.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, { from, to }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" }, ") => { from: React.ReactText; to: React.ReactText; type: \"date_range\"; }" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.dateRangeFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.dateRangeFunction.fn.$2", "type": "Object", "tags": [], "label": "{ from, to }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.DateRange", "text": "DateRange" } ], "path": "src/plugins/data/common/search/expressions/date_range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.esRawResponse", "type": "Object", "tags": [], "label": "esRawResponse", "description": [], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.esRawResponse.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"es_raw_response\"" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.esRawResponse.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.esRawResponse.to.datatable", "type": "Function", "tags": [], "label": "datatable", "description": [], "signature": [ "(context: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsRawResponse", "text": "EsRawResponse" }, ") => { type: string; meta: { type: string; source: string; }; columns: { id: string; name: string; meta: { type: \"string\" | \"number\" | \"bigint\" | \"boolean\" | \"symbol\" | \"undefined\" | \"object\" | \"function\"; field: string; params: {}; }; }[]; rows: any[]; }" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.esRawResponse.to.datatable.$1", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.EsRawResponse", "text": "EsRawResponse" }, "" ], "path": "src/plugins/data/common/search/expressions/es_raw_response.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction", "type": "Object", "tags": [], "label": "existsFilterFunction", "description": [], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"existsFilter\"" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_filter\"" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field", "type": "Object", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"kibana_field\"[]" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.field.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate", "type": "Object", "tags": [], "label": "negate", "description": [], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.default", "type": "boolean", "tags": [], "label": "default", "description": [], "signature": [ "false" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.args.negate.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => { $state?: { store: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" }, "; } | undefined; meta: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterMeta", "text": "FilterMeta" }, "; query?: Record | undefined; type: \"kibana_filter\"; }" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.existsFilterFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.existsFilterFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction", "type": "Object", "tags": [], "label": "extendedBoundsFunction", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"extendedBounds\"" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"extended_bounds\"" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.args.min", "type": "Object", "tags": [], "label": "min", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.args.min.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.args.min.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.args.max", "type": "Object", "tags": [], "label": "max", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.args.max.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.args.max.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, { min, max }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" }, ") => { type: \"extended_bounds\"; }" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.extendedBoundsFunction.fn.$2", "type": "Object", "tags": [], "label": "{ min, max }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExtendedBounds", "text": "ExtendedBounds" } ], "path": "src/plugins/data/common/search/expressions/extended_bounds.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction", "type": "Object", "tags": [], "label": "fieldFunction", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.fieldFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"field\"" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_field\"" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.name", "type": "Object", "tags": [], "label": "name", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args.name.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args.type", "type": "Object", "tags": [], "label": "type", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args.type.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args.script", "type": "Object", "tags": [], "label": "script", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.fieldFunction.args.script.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.fieldFunction.args.script.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.fieldFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_field\", ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.IndexPatternField", "text": "IndexPatternField" }, ">" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.fieldFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.fieldFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/field.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction", "type": "Object", "tags": [], "label": "geoBoundingBoxFunction", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"geoBoundingBox\"" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"geo_bounding_box\"" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.top", "type": "Object", "tags": [], "label": "top", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.top.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.top.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.left", "type": "Object", "tags": [], "label": "left", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.left.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.left.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottom", "type": "Object", "tags": [], "label": "bottom", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottom.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottom.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.right", "type": "Object", "tags": [], "label": "right", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.right.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.right.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.wkt", "type": "Object", "tags": [], "label": "wkt", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.wkt.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.wkt.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.topLeft", "type": "Object", "tags": [], "label": "topLeft", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.topLeft.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"geo_point\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.topLeft.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottomRight", "type": "Object", "tags": [], "label": "bottomRight", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottomRight.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"geo_point\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottomRight.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.topRight", "type": "Object", "tags": [], "label": "topRight", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.topRight.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"geo_point\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.topRight.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottomLeft", "type": "Object", "tags": [], "label": "bottomLeft", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottomLeft.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"geo_point\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.args.bottomLeft.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: GeoBoundingBoxArguments) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"geo_bounding_box\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoBoundingBox", "text": "GeoBoundingBox" }, ">" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.geoBoundingBoxFunction.fn.$2", "type": "CompoundType", "tags": [], "label": "args", "description": [], "signature": [ "GeoBoundingBoxArguments" ], "path": "src/plugins/data/common/search/expressions/geo_bounding_box.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction", "type": "Object", "tags": [], "label": "geoPointFunction", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoPointFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"geoPoint\"" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"geo_point\"" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.lat", "type": "Object", "tags": [], "label": "lat", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.lat.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.lat.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.lon", "type": "Object", "tags": [], "label": "lon", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.lon.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.lon.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.point", "type": "Object", "tags": [], "label": "point", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.point.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.point.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"string\")[]" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.point.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.args.point.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, { lat, lon, point }: GeoPointArguments) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"geo_point\", { value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.GeoPoint", "text": "GeoPoint" }, "; }>" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.geoPointFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.geoPointFunction.fn.$2", "type": "Object", "tags": [], "label": "{ lat, lon, point }", "description": [], "signature": [ "GeoPointArguments" ], "path": "src/plugins/data/common/search/expressions/geo_point.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction", "type": "Object", "tags": [], "label": "ipRangeFunction", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ipRangeFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"ipRange\"" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"ip_range\"" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.from.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.from.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.from.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.to.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.to.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.args.to.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, { from, to }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" }, ") => { from: string; to: string; type: \"ip_range\"; }" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.ipRangeFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.ipRangeFunction.fn.$2", "type": "Object", "tags": [], "label": "{ from, to }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IpRange", "text": "IpRange" } ], "path": "src/plugins/data/common/search/expressions/ip_range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.kibana", "type": "Object", "tags": [], "label": "kibana", "description": [], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibana.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"kibana\"" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibana.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_context\"" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibana.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "(\"kibana_context\" | \"null\")[]" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibana.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibana.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "children": [] }, { "parentPluginId": "data", "id": "def-common.kibana.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: Input, _: object, { getSearchContext }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibana.fn.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "data", "id": "def-common.kibana.fn.$2", "type": "Uncategorized", "tags": [], "label": "_", "description": [], "signature": [ "object" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.kibana.fn.$3", "type": "Object", "tags": [], "label": "{ getSearchContext }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "<", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, ", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">" ], "path": "src/plugins/data/common/search/expressions/kibana.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.kibanaContext", "type": "Object", "tags": [], "label": "kibanaContext", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaContext.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaContext.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaContext.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => { type: string; }" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "children": [], "returnComment": [] } ] }, { "parentPluginId": "data", "id": "def-common.kibanaContext.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaContext.to.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => { type: string; }" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, "children": [], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction", "type": "Object", "tags": [], "label": "kibanaFilterFunction", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"kibanaFilter\"" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_filter\"" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query", "type": "Object", "tags": [], "label": "query", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.query.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate", "type": "Object", "tags": [], "label": "negate", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.default", "type": "boolean", "tags": [], "label": "default", "description": [], "signature": [ "false" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.negate.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.disabled", "type": "Object", "tags": [], "label": "disabled", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.disabled.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.disabled.default", "type": "boolean", "tags": [], "label": "default", "description": [], "signature": [ "false" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.args.disabled.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => { type: \"kibana_filter\"; meta: { negate: boolean; alias: string; disabled: boolean; }; query: any; }" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction", "type": "Object", "tags": [], "label": "kibanaTimerangeFunction", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"timerange\"" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"timerange\"" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.from.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.to.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode", "type": "Object", "tags": [], "label": "mode", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "(\"absolute\" | \"relative\")[]" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.args.mode.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, ") => { type: \"timerange\"; from: string; to: string; mode: \"absolute\" | \"relative\" | undefined; }" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.kibanaTimerangeFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" } ], "path": "src/plugins/data/common/search/expressions/timerange.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction", "type": "Object", "tags": [], "label": "kqlFunction", "description": [], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kqlFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"kql\"" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_query\"" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kqlFunction.args.q", "type": "Object", "tags": [], "label": "q", "description": [], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.kqlFunction.args.q.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.kqlFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => { type: \"kibana_query\"; language: string; query: string; }" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.kqlFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.kqlFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction", "type": "Object", "tags": [], "label": "luceneFunction", "description": [], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.luceneFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"lucene\"" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_query\"" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.luceneFunction.args.q", "type": "Object", "tags": [], "label": "q", "description": [], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.luceneFunction.args.q.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.luceneFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => { type: \"kibana_query\"; language: string; query: any; }" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.luceneFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.luceneFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.migrateIncludeExcludeFormat", "type": "Object", "tags": [], "label": "migrateIncludeExcludeFormat", "description": [], "signature": [ "{ scriptable?: boolean | undefined; filterFieldTypes?: ", { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, " | \"*\" | ", { "pluginId": "@kbn/field-types", "scope": "server", "docId": "kibKbnFieldTypesPluginApi", "section": "def-server.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, "[] | undefined; makeAgg?: ((agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ", state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; schema?: string | undefined; } | undefined) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ") | undefined; allowedAggs?: string[] | undefined; name?: string | undefined; type?: string | undefined; displayName?: string | undefined; required?: boolean | undefined; advanced?: boolean | undefined; default?: any; write?: ((aggConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ", output: Record, aggConfigs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined, locals?: Record | undefined) => void) | undefined; serialize?: ((value: any, aggConfig?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, " | undefined) => any) | undefined; deserialize?: ((value: any, aggConfig?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, " | undefined) => any) | undefined; toExpressionAst?: ((value: any) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[] | undefined) | undefined; options?: any[] | undefined; valueType?: any; onChange?: ((agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ") => void) | undefined; shouldShow?: ((agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ") => boolean) | undefined; modifyAggConfigOnSearchRequestStart?: ((aggConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IBucketAggConfig", "text": "IBucketAggConfig" }, ", searchSource?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSource", "text": "SearchSource" }, ", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchOptions", "text": "ISearchOptions" }, " | undefined) => void) | undefined; }" ], "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction", "type": "Object", "tags": [], "label": "numericalRangeFunction", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"numericalRange\"" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"numerical_range\"" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.from.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.from.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.to.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.to.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.label", "type": "Object", "tags": [], "label": "label", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.label.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.args.label.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, { from, to, label }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" }, ") => { type: \"numerical_range\"; }" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.numericalRangeFunction.fn.$2", "type": "Object", "tags": [], "label": "{ from, to, label }", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.NumericalRange", "text": "NumericalRange" } ], "path": "src/plugins/data/common/search/expressions/numerical_range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper", "type": "Object", "tags": [], "label": "parentPipelineAggHelper", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.subtype", "type": "string", "tags": [], "label": "subtype", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.params", "type": "Function", "tags": [], "label": "params", "description": [], "signature": [ "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggParam", "text": "MetricAggParam" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">[]" ], "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.getSerializedFormat", "type": "Function", "tags": [], "label": "getSerializedFormat", "description": [], "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ") => any" ], "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.parentPipelineAggHelper.getSerializedFormat.$1", "type": "Object", "tags": [], "label": "agg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" } ], "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction", "type": "Object", "tags": [], "label": "phraseFilterFunction", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"rangeFilter\"" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_filter\"" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field", "type": "Object", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"kibana_field\"[]" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.field.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase", "type": "Object", "tags": [], "label": "phrase", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.phrase.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate", "type": "Object", "tags": [], "label": "negate", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.default", "type": "boolean", "tags": [], "label": "default", "description": [], "signature": [ "false" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.args.negate.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => { $state?: { store: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" }, "; } | undefined; meta: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterMeta", "text": "FilterMeta" }, "; query?: Record | undefined; type: \"kibana_filter\"; }" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.phraseFilterFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction", "type": "Object", "tags": [], "label": "queryFilterFunction", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.queryFilterFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"queryFilter\"" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_query_filter\"" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.input", "type": "Object", "tags": [], "label": "input", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.input.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"kibana_query\"[]" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.input.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.input.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.input.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.label", "type": "Object", "tags": [], "label": "label", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.label.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.args.label.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(_: null, { input, label }: QueryFilterArguments) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_query_filter\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.QueryFilter", "text": "QueryFilter" }, ">" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.queryFilterFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "_", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.queryFilterFunction.fn.$2", "type": "Object", "tags": [], "label": "{ input, label }", "description": [], "signature": [ "QueryFilterArguments" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction", "type": "Object", "tags": [], "label": "rangeFilterFunction", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"rangeFilter\"" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_filter\"" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field", "type": "Object", "tags": [], "label": "field", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"kibana_field\"[]" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.field.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range", "type": "Object", "tags": [], "label": "range", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"kibana_range\"[]" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.range.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate", "type": "Object", "tags": [], "label": "negate", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.default", "type": "boolean", "tags": [], "label": "default", "description": [], "signature": [ "false" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.args.negate.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => { $state?: { store: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" }, "; } | undefined; meta: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterMeta", "text": "FilterMeta" }, "; query?: Record | undefined; type: \"kibana_filter\"; }" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.rangeFilterFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction", "type": "Object", "tags": [], "label": "rangeFunction", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"range\"" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_range\"" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt", "type": "Object", "tags": [], "label": "gt", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"string\")[]" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gt.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt", "type": "Object", "tags": [], "label": "lt", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"string\")[]" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lt.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte", "type": "Object", "tags": [], "label": "gte", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"string\")[]" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args.gte.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte", "type": "Object", "tags": [], "label": "lte", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"string\")[]" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.rangeFunction.args.lte.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.rangeFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments) => { gt?: string | number | undefined; lt?: string | number | undefined; gte?: string | number | undefined; lte?: string | number | undefined; type: \"kibana_range\"; }" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.rangeFunction.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.rangeFunction.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/range.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction", "type": "Object", "tags": [], "label": "removeFilterFunction", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.removeFilterFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"removeFilter\"" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_context\"" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"kibana_context\"[]" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.group", "type": "Object", "tags": [], "label": "group", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.group.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.group.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.group.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.from.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.from.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.ungrouped", "type": "Object", "tags": [], "label": "ungrouped", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.ungrouped.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.ungrouped.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.ungrouped.default", "type": "boolean", "tags": [], "label": "default", "description": [], "signature": [ "false" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.args.ungrouped.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">, { group, from, ungrouped }: Arguments) => { filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]; type: \"kibana_context\"; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, "[] | undefined; timeRange?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined; }" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.removeFilterFunction.fn.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.removeFilterFunction.fn.$2", "type": "Object", "tags": [], "label": "{ group, from, ungrouped }", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/remove_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction", "type": "Object", "tags": [], "label": "selectFilterFunction", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.selectFilterFunction.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"selectFilter\"" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"kibana_context\"" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"kibana_context\"[]" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.group", "type": "Object", "tags": [], "label": "group", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.group.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.group.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.group.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.from.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.from.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false } ] }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.ungrouped", "type": "Object", "tags": [], "label": "ungrouped", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.ungrouped.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.ungrouped.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.ungrouped.default", "type": "boolean", "tags": [], "label": "default", "description": [], "signature": [ "false" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.args.ungrouped.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false } ] } ] }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">, { group, ungrouped, from }: Arguments) => { filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]; type: \"kibana_context\"; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, "[] | undefined; timeRange?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined; }" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.selectFilterFunction.fn.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"kibana_context\", ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ExecutionContextSearch", "text": "ExecutionContextSearch" }, ">" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", "id": "def-common.selectFilterFunction.fn.$2", "type": "Object", "tags": [], "label": "{ group, ungrouped, from }", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/data/common/search/expressions/select_filter.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper", "type": "Object", "tags": [], "label": "siblingPipelineAggHelper", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.subtype", "type": "string", "tags": [], "label": "subtype", "description": [], "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "deprecated": false }, { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.params", "type": "Function", "tags": [], "label": "params", "description": [], "signature": [ "(bucketFilter?: string[]) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.MetricAggParam", "text": "MetricAggParam" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ">[]" ], "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.params.$1", "type": "Array", "tags": [], "label": "bucketFilter", "description": [], "signature": [ "string[]" ], "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.getSerializedFormat", "type": "Function", "tags": [], "label": "getSerializedFormat", "description": [], "signature": [ "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" }, ") => any" ], "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "deprecated": false, "children": [ { "parentPluginId": "data", "id": "def-common.siblingPipelineAggHelper.getSerializedFormat.$1", "type": "Object", "tags": [], "label": "agg", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IMetricAggConfig", "text": "IMetricAggConfig" } ], "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ] } }