* Update api docs * update api docs after merge from master # Conflicts: # api_docs/core.json # api_docs/data.json # api_docs/data_index_patterns.json # api_docs/licensing.json # api_docs/saved_objects.json
31758 lines
No EOL
1 MiB
31758 lines
No EOL
1 MiB
{
|
|
"id": "data.search",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "PainlessError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.PainlessError",
|
|
"text": "PainlessError"
|
|
},
|
|
" extends ",
|
|
"EsError"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError.painlessStack",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "painlessStack",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError.indexPattern",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "err",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.IEsError",
|
|
"text": "IEsError"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError.getErrorMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getErrorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"(application: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ApplicationStart",
|
|
"text": "ApplicationStart"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.PainlessError.getErrorMessage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "application",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ApplicationStart",
|
|
"text": "ApplicationStart"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/painless_error.tsx",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SearchInterceptor",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 68
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.SearchInterceptorDeps",
|
|
"text": "SearchInterceptorDeps"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 116
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.search",
|
|
"type": "Function",
|
|
"tags": [
|
|
"options"
|
|
],
|
|
"label": "search",
|
|
"description": [
|
|
"\nSearches using the given `search` method. Overrides the `AbortSignal` with one that will abort\neither when the request times out, or when the original `AbortSignal` is aborted. Updates\n`pendingCount$` when the request is started/finalized.\n"
|
|
],
|
|
"signature": [
|
|
"({ id, ...request }: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any>, options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IAsyncSearchOptions",
|
|
"text": "IAsyncSearchOptions"
|
|
},
|
|
") => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 316
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.search.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ id, ...request }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 316
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.search.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IAsyncSearchOptions",
|
|
"text": "IAsyncSearchOptions"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 316
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"`Observable` emitting the search response or an error."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.showError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "showError",
|
|
"description": [],
|
|
"signature": [
|
|
"(e: Error) => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 413
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptor.showError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "e",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 413
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchTimeoutError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SearchTimeoutError",
|
|
"description": [
|
|
"\nRequest Failure - When an entire multi request fails"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.SearchTimeoutError",
|
|
"text": "SearchTimeoutError"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.KbnError",
|
|
"text": "KbnError"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchTimeoutError.mode",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "mode",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.TimeoutErrorMode",
|
|
"text": "TimeoutErrorMode"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchTimeoutError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchTimeoutError.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "err",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchTimeoutError.Unnamed.$2",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "mode",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.TimeoutErrorMode",
|
|
"text": "TimeoutErrorMode"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchTimeoutError.getErrorMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getErrorMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"(application: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ApplicationStart",
|
|
"text": "ApplicationStart"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 66
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchTimeoutError.getErrorMessage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "application",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ApplicationStart",
|
|
"text": "ApplicationStart"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 66
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.getEsPreference",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEsPreference",
|
|
"description": [],
|
|
"signature": [
|
|
"(uiSettings: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
", sessionId: string) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/es_search/get_es_preference.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.getEsPreference.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/es_search/get_es_preference.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.getEsPreference.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/es_search/get_es_preference.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.isEsError.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "e",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"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\" | \"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_helpers.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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\" | \"clear\" | \"cancel\" | \"save\" | \"renameCurrentSession\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_helpers.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_helpers.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISearchSetup.aggs",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aggs",
|
|
"description": [],
|
|
"signature": [
|
|
"AggsCommonSetup"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISearchSetup.usageCollector",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usageCollector",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchUsageCollector",
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"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",
|
|
"<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise<void>; save: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
", \"isStored\" | \"isRestore\" | \"sessionId\">> | null; enableStorage: <ID extends string = string>(searchSessionInfoProvider: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.SearchSessionInfoProvider",
|
|
"text": "SearchSessionInfoProvider"
|
|
},
|
|
"<ID>, searchSessionIndicatorUiConfig?: ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
" | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISearchSetup.sessionsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sessionsClient",
|
|
"description": [
|
|
"\nSearch sessions SO CRUD\n{@link ISessionsClient}"
|
|
],
|
|
"signature": [
|
|
"{ get: (sessionId: string) => Promise<",
|
|
"SearchSessionSavedObject",
|
|
">; delete: (sessionId: string) => Promise<void>; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; urlGeneratorId: string; sessionId: string; }) => Promise<",
|
|
"SearchSessionSavedObject",
|
|
">; 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"
|
|
},
|
|
"<unknown, unknown>>; 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"
|
|
},
|
|
"<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSessionSavedObjectAttributes",
|
|
"text": "SearchSessionSavedObjectAttributes"
|
|
},
|
|
", \"name\">>>; 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>>; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISearchStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISearchStart",
|
|
"description": [
|
|
"\nsearch service"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
", configStates?: Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & 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\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
},
|
|
"; types: ",
|
|
"AggTypesRegistryStart",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISearchStart.search",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [
|
|
"\nlow level search\n{@link ISearchGeneric}"
|
|
],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"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"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(request: SearchStrategyRequest, options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => ",
|
|
"Observable",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.request",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchStrategyRequest"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISearchStart.showError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "showError",
|
|
"description": [],
|
|
"signature": [
|
|
"(e: Error) => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.e",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "e",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"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",
|
|
"<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise<void>; save: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
", \"isStored\" | \"isRestore\" | \"sessionId\">> | null; enableStorage: <ID extends string = string>(searchSessionInfoProvider: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.SearchSessionInfoProvider",
|
|
"text": "SearchSessionInfoProvider"
|
|
},
|
|
"<ID>, searchSessionIndicatorUiConfig?: ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
" | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISearchStart.sessionsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sessionsClient",
|
|
"description": [
|
|
"\nSearch sessions SO CRUD\n{@link ISessionsClient}"
|
|
],
|
|
"signature": [
|
|
"{ get: (sessionId: string) => Promise<",
|
|
"SearchSessionSavedObject",
|
|
">; delete: (sessionId: string) => Promise<void>; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; urlGeneratorId: string; sessionId: string; }) => Promise<",
|
|
"SearchSessionSavedObject",
|
|
">; 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"
|
|
},
|
|
"<unknown, unknown>>; 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"
|
|
},
|
|
"<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSessionSavedObjectAttributes",
|
|
"text": "SearchSessionSavedObjectAttributes"
|
|
},
|
|
", \"name\">>>; 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>>; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/types.ts",
|
|
"lineNumber": 70
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Reason",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason.reason",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "reason",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason.script_stack",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "script_stack",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason.position",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "position",
|
|
"description": [],
|
|
"signature": [
|
|
"{ offset: number; start: number; end: number; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason.lang",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "lang",
|
|
"description": [],
|
|
"signature": [
|
|
"\"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason.script",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "script",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.Reason.caused_by",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "caused_by",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; reason: string; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchInterceptorDeps",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps.bfetch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bfetch",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "bfetch",
|
|
"scope": "public",
|
|
"docId": "kibBfetchPluginApi",
|
|
"section": "def-public.BfetchPublicContract",
|
|
"text": "BfetchPublicContract"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-public.HttpSetup",
|
|
"text": "HttpSetup"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps.startServices",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "startServices",
|
|
"description": [],
|
|
"signature": [
|
|
"Promise<[",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", any, unknown]>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps.toasts",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [],
|
|
"signature": [
|
|
"{ get$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"[]>; add: (toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"; remove: (toastOrId: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
") => void; addSuccess: (toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
", options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"; addWarning: (toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
", options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"; addDanger: (toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
", options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"; addError: (error: Error, options: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ErrorToastOptions",
|
|
"text": "ErrorToastOptions"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"; addInfo: (toastOrTitle: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
},
|
|
", options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps.usageCollector",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usageCollector",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchUsageCollector",
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchInterceptorDeps.session",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "session",
|
|
"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",
|
|
"<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise<void>; save: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
", \"isStored\" | \"isRestore\" | \"sessionId\">> | null; enableStorage: <ID extends string = string>(searchSessionInfoProvider: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.SearchSessionInfoProvider",
|
|
"text": "SearchSessionInfoProvider"
|
|
},
|
|
"<ID>, searchSessionIndicatorUiConfig?: ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
" | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/search_interceptor/search_interceptor.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"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"
|
|
},
|
|
"<ID>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_service.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"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<string>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_service.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_service.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.SearchSessionInfoProvider.getUrlGeneratorData",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUrlGeneratorData",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<{ urlGeneratorId: ID; initialState: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[ID][\"State\"]; restoreState: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorStateMapping",
|
|
"text": "UrlGeneratorStateMapping"
|
|
},
|
|
"[ID][\"State\"]; }>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_service.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.WaitUntilNextSessionCompletesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "WaitUntilNextSessionCompletesOptions",
|
|
"description": [
|
|
"\nOptions for {@link waitUntilNextSessionCompletes$}"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_helpers.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_helpers.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/search_session_state.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.TimeoutErrorMode",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "TimeoutErrorMode",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/timeout_error.tsx",
|
|
"lineNumber": 15
|
|
},
|
|
"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",
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/errors/types.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-public.ISessionsClient",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ISessionsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ get: (sessionId: string) => Promise<",
|
|
"SearchSessionSavedObject",
|
|
">; delete: (sessionId: string) => Promise<void>; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; urlGeneratorId: string; sessionId: string; }) => Promise<",
|
|
"SearchSessionSavedObject",
|
|
">; 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"
|
|
},
|
|
"<unknown, unknown>>; 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"
|
|
},
|
|
"<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSessionSavedObjectAttributes",
|
|
"text": "SearchSessionSavedObjectAttributes"
|
|
},
|
|
", \"name\">>>; 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>>; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/sessions_client.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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",
|
|
"<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise<void>; save: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
", \"isStored\" | \"isRestore\" | \"sessionId\">> | null; enableStorage: <ID extends string = string>(searchSessionInfoProvider: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.SearchSessionInfoProvider",
|
|
"text": "SearchSessionInfoProvider"
|
|
},
|
|
"<ID>, searchSessionIndicatorUiConfig?: ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
" | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => ",
|
|
"SearchSessionIndicatorUiConfig",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/session_service.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/i18n.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/search/session/constants.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/errors/no_search_id_in_session.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.NoSearchIdInSessionError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/errors/no_search_id_in_session.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.getDefaultSearchParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDefaultSearchParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(uiSettingsClient: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
") => Promise<Pick<",
|
|
"Search",
|
|
"<",
|
|
"RequestBody",
|
|
"<Record<string, any>>>, \"max_concurrent_shard_requests\" | \"ignore_unavailable\" | \"track_total_hits\">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.getDefaultSearchParams.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettingsClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.getShardTimeout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getShardTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"(config: Readonly<{ kibana: Readonly<{ readonly index: string; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; isLessThan: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; isEqualTo: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>) => Pick<",
|
|
"Search",
|
|
"<",
|
|
"RequestBody",
|
|
"<Record<string, any>>>, \"timeout\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.getShardTimeout.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<{ kibana: Readonly<{ readonly index: string; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; isLessThan: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; isEqualTo: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/es_search/request_utils.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.searchUsageObserver",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "searchUsageObserver",
|
|
"description": [
|
|
"\nRxjs observer for easily doing `tap(searchUsageObserver(logger, usage))` in an rxjs chain."
|
|
],
|
|
"signature": [
|
|
"(logger: ",
|
|
"Logger",
|
|
", usage: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.SearchUsage",
|
|
"text": "SearchUsage"
|
|
},
|
|
" | undefined, { isRestore }: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
") => { next(response: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>): void; error(): void; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 82
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.searchUsageObserver.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
"Logger"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 83
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.searchUsageObserver.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.SearchUsage",
|
|
"text": "SearchUsage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 84
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.searchUsageObserver.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ isRestore }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 85
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.usageProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "usageProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.SearchUsage",
|
|
"text": "SearchUsage"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.usageProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AsyncSearchResponse",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.AsyncSearchResponse",
|
|
"text": "AsyncSearchResponse"
|
|
},
|
|
"<T>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchResponse.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchResponse.response",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchResponse",
|
|
"<T>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchResponse.start_time_in_millis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "start_time_in_millis",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchResponse.expiration_time_in_millis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "expiration_time_in_millis",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchResponse.is_partial",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_partial",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchResponse.is_running",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "is_running",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.AsyncSearchResponse",
|
|
"text": "AsyncSearchResponse"
|
|
},
|
|
"<unknown>, \"id\" | \"start_time_in_millis\" | \"expiration_time_in_millis\" | \"is_partial\" | \"is_running\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchStatusResponse.completion_status",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "completion_status",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.AsyncSearchStatusResponse._shards",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "_shards",
|
|
"description": [],
|
|
"signature": [
|
|
"ShardsResponse"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.IScopedSearchClient.saveSession",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "saveSession",
|
|
"description": [],
|
|
"signature": [
|
|
"(sessionId: string, attributes: Partial<unknown>) => Promise<",
|
|
"SavedObject",
|
|
"<unknown> | undefined>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 91
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.sessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.attributes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [P in keyof T]?: T[P] | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.IScopedSearchClient.getSession",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSession",
|
|
"description": [],
|
|
"signature": [
|
|
"(sessionId: string) => Promise<",
|
|
"SavedObject",
|
|
"<unknown>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.sessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown, unknown>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 93
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ filter?: any; aggs?: Record<string, ",
|
|
"AggregationsAggregationContainer",
|
|
"> | 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<string, string[] | undefined> | undefined; preference?: string | undefined; pit?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsPitParams",
|
|
"text": "SavedObjectsPitParams"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.IScopedSearchClient.updateSession",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateSession",
|
|
"description": [],
|
|
"signature": [
|
|
"(sessionId: string, attributes: Partial<unknown>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<unknown>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 94
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.sessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.attributes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [P in keyof T]?: T[P] | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.IScopedSearchClient.cancelSession",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "cancelSession",
|
|
"description": [],
|
|
"signature": [
|
|
"(sessionId: string) => Promise<{}>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.sessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.IScopedSearchClient.deleteSession",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deleteSession",
|
|
"description": [],
|
|
"signature": [
|
|
"(sessionId: string) => Promise<{}>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 96
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.sessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 97
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.sessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.expires",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "expires",
|
|
"description": [],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"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"
|
|
},
|
|
"<T>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
"IScopedSearchSessionsClient",
|
|
"<T>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.core",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/session/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISearchSetup",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchSetup.aggs",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aggs",
|
|
"description": [],
|
|
"signature": [
|
|
"AggsCommonSetup"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchSetup.registerSearchStrategy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerSearchStrategy",
|
|
"description": [
|
|
"\nExtension point exposed for other plugins to register their own search\nstrategies."
|
|
],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"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"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(name: string, strategy: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.ISearchStrategy",
|
|
"text": "ISearchStrategy"
|
|
},
|
|
"<SearchStrategyRequest, SearchStrategyResponse>) => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.strategy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "strategy",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.ISearchStrategy",
|
|
"text": "ISearchStrategy"
|
|
},
|
|
"<SearchStrategyRequest, SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchSetup.usage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usage",
|
|
"description": [
|
|
"\nUsed internally for telemetry"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.SearchUsage",
|
|
"text": "SearchUsage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISearchStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.ISearchStart",
|
|
"text": "ISearchStart"
|
|
},
|
|
"<SearchStrategyRequest, SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 100
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchStart.aggs",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aggs",
|
|
"description": [],
|
|
"signature": [
|
|
"AggsStart"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 104
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchStart.getSearchStrategy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSearchStrategy",
|
|
"description": [
|
|
"\nGet other registered search strategies by name (or, by default, the Elasticsearch strategy).\nFor example, if a new strategy needs to use the already-registered ES search strategy, it can\nuse this function to accomplish that."
|
|
],
|
|
"signature": [
|
|
"(name?: string | undefined) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.ISearchStrategy",
|
|
"text": "ISearchStrategy"
|
|
},
|
|
"<SearchStrategyRequest, SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 110
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 111
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchStart.asScoped",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asScoped",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.IScopedSearchClient",
|
|
"text": "IScopedSearchClient"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 113
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.request",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 113
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.ISearchStart.searchSource",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSource",
|
|
"description": [],
|
|
"signature": [
|
|
"{ asScoped: (request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchStartSearchSource",
|
|
"text": "ISearchStartSearchSource"
|
|
},
|
|
">; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 114
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
"<SearchStrategyRequest, SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"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",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.request",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchStrategyRequest"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 77
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 78
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.deps",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "server",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-server.SearchStrategyDependencies",
|
|
"text": "SearchStrategyDependencies"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 79
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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<void>) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 81
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"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<void>) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 82
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchStrategyDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchStrategyDependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchStrategyDependencies.savedObjectsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ get: <T = unknown>(type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBaseOptions",
|
|
"text": "SavedObjectsBaseOptions"
|
|
},
|
|
") => Promise<",
|
|
"SavedObject",
|
|
"<T>>; delete: (type: string, id: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsDeleteOptions",
|
|
"text": "SavedObjectsDeleteOptions"
|
|
},
|
|
") => Promise<{}>; create: <T = unknown>(type: string, attributes: T, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsCreateOptions",
|
|
"text": "SavedObjectsCreateOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkCreateObject",
|
|
"text": "SavedObjectsBulkCreateObject"
|
|
},
|
|
"<T>[], 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"
|
|
},
|
|
"<T>>; 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"
|
|
},
|
|
">; find: <T = unknown, A = unknown>(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"
|
|
},
|
|
"<T, A>>; bulkGet: <T = unknown>(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"
|
|
},
|
|
"<T>>; resolve: <T = unknown>(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"
|
|
},
|
|
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateOptions",
|
|
"text": "SavedObjectsUpdateOptions"
|
|
},
|
|
"<T>) => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsUpdateResponse",
|
|
"text": "SavedObjectsUpdateResponse"
|
|
},
|
|
"<T>>; 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: <T = unknown>(objects: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsBulkUpdateObject",
|
|
"text": "SavedObjectsBulkUpdateObject"
|
|
},
|
|
"<T>[], 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"
|
|
},
|
|
"<T>>; 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: <T = unknown, A = unknown>(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"
|
|
},
|
|
"<T, A>; errors: typeof ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsErrorHelpers",
|
|
"text": "SavedObjectsErrorHelpers"
|
|
},
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchStrategyDependencies.uiSettingsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettingsClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchStrategyDependencies.searchSessionsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSessionsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"IScopedSearchSessionsClient",
|
|
"<unknown>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchUsage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchUsage",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchUsage.trackError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "trackError",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchUsage.trackSuccess",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "trackSuccess",
|
|
"description": [],
|
|
"signature": [
|
|
"(duration: number) => Promise<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-server.SearchUsage.trackSuccess.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/collectors/usage.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/server/search/types.ts",
|
|
"lineNumber": 119
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "AggConfig",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"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[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"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[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 85
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 85
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 94
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 96
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.params",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 97
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 98
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.brandNew",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "brandNew",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 99
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.schema",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 100
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 106
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 106
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & 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\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 106
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 136
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 136
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getParam",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParam",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 173
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getParam.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 173
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.hasTimeShift",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasTimeShift",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 177
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getTimeShift",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTimeShift",
|
|
"description": [],
|
|
"signature": [
|
|
"() => moment.Duration | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 181
|
|
},
|
|
"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<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 201
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 201
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.isFilterable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isFilterable",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 205
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.createFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string, params?: {}) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 209
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.createFilter.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 209
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.createFilter.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 209
|
|
},
|
|
"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<void> | Promise<any[]>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 235
|
|
},
|
|
"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\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 235
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 235
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 256
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 256
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 291
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 322
|
|
},
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "visualizations",
|
|
"link": {
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"lineNumber": 172
|
|
}
|
|
}
|
|
],
|
|
"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": [
|
|
"() => {}"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 333
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 342
|
|
},
|
|
"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"
|
|
},
|
|
">[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 397
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 401
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 405
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getValue",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getValue",
|
|
"description": [],
|
|
"signature": [
|
|
"(bucket: any) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 409
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getValue.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "bucket",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 409
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 413
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getKey.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "bucket",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 413
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getKey.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 413
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getFieldDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 421
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getField",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getField",
|
|
"description": [],
|
|
"signature": [
|
|
"() => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 427
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 436
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.makeLabel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "makeLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"(percentageMode?: boolean) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 440
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.makeLabel.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "percentageMode",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 440
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.getIndexPattern",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIndexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 454
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 458
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.fieldName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fieldName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 462
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfig.fieldIsTimeField",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fieldIsTimeField",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 467
|
|
},
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 478
|
|
},
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 482
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 512
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 512
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "AggConfigs",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 78
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.indexPattern",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 79
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 80
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.timeFields",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "timeFields",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 81
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.forceNow",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "forceNow",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 82
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.hierarchical",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hierarchical",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 83
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 87
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 89
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.Unnamed.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "configStates",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & 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\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 91
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.setTimeFields",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setTimeFields",
|
|
"description": [],
|
|
"signature": [
|
|
"(timeFields: string[] | undefined) => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 105
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.setTimeFields.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "timeFields",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 105
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.setForceNow",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setForceNow",
|
|
"description": [],
|
|
"signature": [
|
|
"(now: Date | undefined) => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 109
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.setForceNow.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "now",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 109
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 113
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 113
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 134
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 144
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.clone.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ enabledOnly = true }",
|
|
"description": [],
|
|
"signature": [
|
|
"{ enabledOnly?: boolean | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 144
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.createAggConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createAggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfig",
|
|
"text": "AggConfig"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfig",
|
|
"text": "AggConfig"
|
|
},
|
|
">(params: Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & 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\" | \"enabled\" | \"id\" | \"schema\" | \"params\">, { addToAggConfigs }?: { addToAggConfigs?: boolean | undefined; }) => T"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 157
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.createAggConfig.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & 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\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 158
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.createAggConfig.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ addToAggConfigs = true }",
|
|
"description": [],
|
|
"signature": [
|
|
"{ addToAggConfigs?: boolean | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 159
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 200
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 200
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.toDsl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toDsl",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 212
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 302
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 306
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.byIndex.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "index",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 306
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 310
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.byId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 310
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 314
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.byName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 314
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 318
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.byType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 318
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 322
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.byTypeName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 322
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 326
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.bySchemaName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 326
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 330
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.getTimeShifts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTimeShifts",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Record<string, moment.Duration>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 344
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.getTimeShiftInterval",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTimeShiftInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"() => moment.Duration | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 359
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.hasTimeShifts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasTimeShifts",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 366
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.getSearchSourceTimeFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSearchSourceTimeFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"(forceNow?: Date | undefined) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"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; }; }; }[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 370
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.getSearchSourceTimeFilter.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "forceNow",
|
|
"description": [],
|
|
"signature": [
|
|
"Date | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 370
|
|
},
|
|
"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"
|
|
},
|
|
"<any>) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 423
|
|
},
|
|
"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"
|
|
},
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 423
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 442
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigs.getRequestAggById.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 442
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 457
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 471
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 471
|
|
},
|
|
"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]>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 480
|
|
},
|
|
"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\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 480
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 480
|
|
},
|
|
"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"
|
|
},
|
|
"<TAggConfig> extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BaseParamType",
|
|
"text": "BaseParamType"
|
|
},
|
|
"<TAggConfig>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined) => TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamType.allowedAggs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "allowedAggs",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/agg.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/aggs_service.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggsCommonService.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"({ registerFunction }: ",
|
|
"AggsCommonSetupDependencies",
|
|
") => ",
|
|
"AggsCommonSetup"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/aggs_service.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggsCommonService.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ registerFunction }",
|
|
"description": [],
|
|
"signature": [
|
|
"AggsCommonSetupDependencies"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/aggs_service.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggsCommonService.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getConfig, getIndexPattern, isDefaultTimezone, }: ",
|
|
"AggsCommonStartDependencies",
|
|
") => ",
|
|
"AggsCommonStart"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/aggs_service.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/aggs_service.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"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"
|
|
},
|
|
"<TAggConfig, TParam>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 64
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 74
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.subtype",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "subtype",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 77
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 84
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 91
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 98
|
|
},
|
|
"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\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 103
|
|
},
|
|
"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)"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 112
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [
|
|
"- label that can be used in the ui to describe the aggConfig"
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [
|
|
"- an agg config of this type"
|
|
],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 112
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 127
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 135
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 141
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 148
|
|
},
|
|
"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[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 155
|
|
},
|
|
"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[])"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 165
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [
|
|
"- an array of aggConfig objects\n that should replace this one,\n or undefined"
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 165
|
|
},
|
|
"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[])"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 176
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [
|
|
"- an array of aggConfig objects\n that should replace this one,\n or undefined"
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 176
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 181
|
|
},
|
|
"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",
|
|
"<any>, 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",
|
|
"<any>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 194
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.resp",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "resp",
|
|
"description": [
|
|
"- Response to the main request"
|
|
],
|
|
"signature": [
|
|
"SearchResponse",
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfigs",
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [
|
|
"- AggConfig that requested the post flight request"
|
|
],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.searchSource",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSource",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; history: Record<string, any>[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(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: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; setFields: (newFields: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; getId: () => string; getFields: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"; getField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, recurse?: boolean) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]; getOwnField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(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",
|
|
"<any>>>; fetch: (options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
") => Promise<",
|
|
"SearchResponse",
|
|
"<any>>; 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<unknown>) => 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",
|
|
"[]; }; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.inspectorRequestAdapter",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "inspectorRequestAdapter",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.RequestAdapter",
|
|
"text": "RequestAdapter"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.abortSignal",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "abortSignal",
|
|
"description": [
|
|
"- `AbortSignal` to abort the request"
|
|
],
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.searchSessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchSessionId",
|
|
"description": [
|
|
"- searchSessionId to be used for grouping requests into a single search session"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 204
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [
|
|
"- the agg to pick a format for"
|
|
],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 204
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.getValue",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getValue",
|
|
"description": [],
|
|
"signature": [
|
|
"(agg: TAggConfig, bucket: any) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 206
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 206
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.bucket",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "bucket",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 206
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.getKey",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getKey",
|
|
"description": [],
|
|
"signature": [
|
|
"((bucket: any, key: any, agg: TAggConfig) => any) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 208
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.paramByName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "paramByName",
|
|
"description": [],
|
|
"signature": [
|
|
"(name: string) => TParam | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 210
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.paramByName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 210
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.getValueBucketPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getValueBucketPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(agg: TAggConfig) => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 214
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.getValueBucketPath.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 214
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 218
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggType.splitForTimeShift.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 218
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 218
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 231
|
|
},
|
|
"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"
|
|
},
|
|
"<TAggConfig, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggParamType",
|
|
"text": "AggParamType"
|
|
},
|
|
"<TAggConfig>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 231
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypesRegistry",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "AggTypesRegistry",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_types_registry.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypesRegistry.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { registerBucket: <N extends string, T extends (deps: ",
|
|
"AggTypesDependencies",
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BucketAggType",
|
|
"text": "BucketAggType"
|
|
},
|
|
"<any>>(name: N, type: T) => void; registerMetric: <N extends string, T extends (deps: ",
|
|
"AggTypesDependencies",
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.MetricAggType",
|
|
"text": "MetricAggType"
|
|
},
|
|
"<any>>(name: N, type: T) => void; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_types_registry.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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[]; }; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_types_registry.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"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"
|
|
},
|
|
"<TAggConfig>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.displayName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "displayName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.advanced",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "advanced",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.default",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "default",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.write",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "write",
|
|
"description": [],
|
|
"signature": [
|
|
"(aggConfig: TAggConfig, output: Record<string, any>, aggConfigs?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
},
|
|
" | undefined, locals?: Record<string, any> | undefined) => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.output",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "output",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfigs",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aggConfigs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.locals",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "locals",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.serialize",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "serialize",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: any, aggConfig?: TAggConfig | undefined) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.value",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.deserialize",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deserialize",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: any, aggConfig?: TAggConfig | undefined) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.value",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"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"
|
|
},
|
|
" | undefined) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.options",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"any[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.valueType",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "valueType",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggConfig",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"TAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.searchSource",
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BaseParamType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/base.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"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"
|
|
},
|
|
"<TBucketAggConfig> extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggType",
|
|
"text": "AggType"
|
|
},
|
|
"<TBucketAggConfig, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BucketAggParam",
|
|
"text": "BucketAggParam"
|
|
},
|
|
"<TBucketAggConfig>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.getKey",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getKey",
|
|
"description": [],
|
|
"signature": [
|
|
"(bucket: any, key: any, agg: TBucketAggConfig) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.bucket",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "bucket",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TBucketAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.getShiftedKey.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TBucketAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.getShiftedKey.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ReactText"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.getShiftedKey.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeShift",
|
|
"description": [],
|
|
"signature": [
|
|
"moment.Duration"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.getTimeShiftInterval",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTimeShiftInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"(agg: TBucketAggConfig) => moment.Duration | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.getTimeShiftInterval.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TBucketAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.orderBuckets.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"TBucketAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 59
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"BucketAggTypeConfig<TBucketAggConfig>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMask",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "CidrMask",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMask.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMask.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cidr",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMask.getRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRange",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { from: string; to: string; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMask.toString",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toString",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FieldParamType.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FieldParamType.scriptable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "scriptable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FieldParamType.filterFieldTypes",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "filterFieldTypes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
" | \"*\" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FieldParamType.onlyAggregatable",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "onlyAggregatable",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FieldParamType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FieldParamType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 126
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 126
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.InvalidEsCalendarIntervalError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "unit",
|
|
"description": [],
|
|
"signature": [
|
|
"Unit"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.InvalidEsCalendarIntervalError.Unnamed.$4",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.InvalidEsIntervalFormatError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.InvalidEsIntervalFormatError.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IpAddress",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IpAddress",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/ip_address.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IpAddress.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/ip_address.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IpAddress.Unnamed.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ipAddress",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | number[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/ip_address.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IpAddress.toString",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toString",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/ip_address.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IpAddress.valueOf",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "valueOf",
|
|
"description": [],
|
|
"signature": [
|
|
"() => number | bigint"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/ip_address.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/json.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.JsonParamType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/json.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.JsonParamType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/json.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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"
|
|
},
|
|
"<TMetricAggConfig> extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggType",
|
|
"text": "AggType"
|
|
},
|
|
"<TMetricAggConfig, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.MetricAggParam",
|
|
"text": "MetricAggParam"
|
|
},
|
|
"<TMetricAggConfig>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggType.subtype",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "subtype",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggType.isScalable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isScalable",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggType.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggType.getKey",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getKey",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"MetricAggTypeConfig<TMetricAggConfig>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.OptionedParamType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.OptionedParamType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/request_error.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/request_error.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.RequestFailure.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/request_error.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/request_error.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/request_error.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SearchSource",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 127
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.history",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "history",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 135
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 139
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 139
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 139
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 157
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.setPreferredSearchStrategyId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchStrategyId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 157
|
|
},
|
|
"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": [
|
|
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, value: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]) => this"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 166
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.setField.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [
|
|
": field name"
|
|
],
|
|
"signature": [
|
|
"K"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 166
|
|
},
|
|
"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]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 166
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.removeField",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeField",
|
|
"description": [
|
|
"\nremove field"
|
|
],
|
|
"signature": [
|
|
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => this"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 178
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.removeField.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [
|
|
": field name"
|
|
],
|
|
"signature": [
|
|
"K"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 178
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 189
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 189
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.getId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getId",
|
|
"description": [
|
|
"\nreturns search source id"
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 197
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 204
|
|
},
|
|
"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": [
|
|
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, recurse?: boolean) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 211
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.getField.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"K"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 211
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.getField.$2",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "recurse",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 211
|
|
},
|
|
"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": [
|
|
"<K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 222
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.getOwnField.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"K"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 222
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 229
|
|
},
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "discover",
|
|
"link": {
|
|
"path": "src/plugins/discover/public/application/embeddable/saved_search_embeddable.tsx",
|
|
"lineNumber": 288
|
|
}
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"link": {
|
|
"path": "src/plugins/discover/public/application/embeddable/saved_search_embeddable.tsx",
|
|
"lineNumber": 294
|
|
}
|
|
}
|
|
],
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 236
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 250
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.createChild.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 250
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 262
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 262
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 262
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 272
|
|
},
|
|
"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",
|
|
"<any>>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 280
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 281
|
|
},
|
|
"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",
|
|
"<any>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 318
|
|
},
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "discover",
|
|
"link": {
|
|
"path": "src/plugins/discover/public/application/angular/context/api/utils/fetch_hits_in_interval.ts",
|
|
"lineNumber": 77
|
|
}
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"link": {
|
|
"path": "src/plugins/discover/public/application/angular/context/api/anchor.ts",
|
|
"lineNumber": 52
|
|
}
|
|
},
|
|
{
|
|
"plugin": "maps",
|
|
"link": {
|
|
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts",
|
|
"lineNumber": 273
|
|
}
|
|
},
|
|
{
|
|
"plugin": "maps",
|
|
"link": {
|
|
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx",
|
|
"lineNumber": 530
|
|
}
|
|
},
|
|
{
|
|
"plugin": "maps",
|
|
"link": {
|
|
"path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx",
|
|
"lineNumber": 819
|
|
}
|
|
}
|
|
],
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 318
|
|
},
|
|
"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<unknown>) => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 331
|
|
},
|
|
"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<unknown>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 332
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 340
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.destroy",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "destroy",
|
|
"description": [
|
|
"\nCompletely destroy the SearchSource."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 348
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 848
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSource.getSerializedFields.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "recurse",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 848
|
|
},
|
|
"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[<number>].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created."
|
|
],
|
|
"signature": [
|
|
"() => { searchSourceJSON: string; references: ",
|
|
"SavedObjectReference",
|
|
"[]; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 877
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SearchSourceService",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source_service.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceService.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source_service.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceService.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(indexPatterns: Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, 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"
|
|
},
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source_service.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceService.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPatterns",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source_service.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source_service.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceService.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source_service.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/string.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.StringParamType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/string.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.StringParamType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/string.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggAvg",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggAvg",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketAvg",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggBucketAvg",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketMax",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggBucketMax",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketMin",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggBucketMin",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketSum",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggBucketSum",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggCardinality",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggCardinality",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggCount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggCount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggCumulativeSum",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggCumulativeSum",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggDateHistogram",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggDateHistogram",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggDateRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggDateRange",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggDerivative",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggDerivative",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggFilteredMetric",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggFilteredMetric",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/filtered_metric_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggFilters",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggFilters",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoBounds",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggGeoBounds",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoCentroid",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggGeoCentroid",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoHash",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggGeoHash",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoTile",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggGeoTile",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggHistogram",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggHistogram",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggIpRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggIpRange",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMax",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggMax",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMedian",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggMedian",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMin",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggMin",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMovingAvg",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggMovingAvg",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggPercentileRanks",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggPercentileRanks",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggPercentiles",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggPercentiles",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggRange",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSerialDiff",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggSerialDiff",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSignificantTerms",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggSignificantTerms",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSinglePercentile",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggSinglePercentile",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/single_percentile_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggStdDeviation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggStdDeviation",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSum",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggSum",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggTerms",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggTerms",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggTopHit",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "aggTopHit",
|
|
"description": [],
|
|
"signature": [
|
|
"() => FunctionDefinition"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts",
|
|
"lineNumber": 252
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.calcAutoIntervalLessThan.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxBucketCount",
|
|
"description": [
|
|
"maximum number of buckets to create"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts",
|
|
"lineNumber": 252
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts",
|
|
"lineNumber": 252
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts",
|
|
"lineNumber": 225
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.calcAutoIntervalNear.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "targetBucketCount",
|
|
"description": [
|
|
"desired number of buckets"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts",
|
|
"lineNumber": 225
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.calcAutoIntervalNear.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "duration",
|
|
"description": [
|
|
"time range the agg covers"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts",
|
|
"lineNumber": 225
|
|
},
|
|
"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.DateRangeKey",
|
|
"text": "DateRangeKey"
|
|
},
|
|
", format: (val: any) => string) => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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.DateRangeKey",
|
|
"text": "DateRangeKey"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.convertDateRangeToString.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: any) => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.convertIPRangeToString.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: any) => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, 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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/create_search_source.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternsService",
|
|
"text": "IndexPatternsService"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"migrate\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/create_search_source.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/create_search_source.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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",
|
|
"[]]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/extract_references.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/extract_references.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.filtersToAst",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "filtersToAst",
|
|
"description": [],
|
|
"signature": [
|
|
"(filters: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]) => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpressionBuilder",
|
|
"text": "ExpressionAstExpressionBuilder"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/filters_to_ast.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.filtersToAst.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/filters_to_ast.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"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<string, any>, 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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/utils/function_wrapper.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/avg.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getCalculateAutoTimeExpression.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/count.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"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"
|
|
},
|
|
") => { interval: string | undefined; timeZone: string | undefined; timeRange: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/get_date_histogram_meta.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/derivative.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esdsl.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getEsdslFn.$1.getStartDependencies",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n getStartDependencies,\n}",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esdsl.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getEsdslFn.$1.getStartDependencies.getStartDependencies",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStartDependencies",
|
|
"description": [],
|
|
"signature": [
|
|
"(getKibanaRequest: any) => Promise<",
|
|
"EsdslStartDependencies",
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esdsl.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getKibanaRequest",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "getKibanaRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esdsl.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getFilterBucketAgg",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFilterBucketAgg",
|
|
"description": [],
|
|
"signature": [
|
|
"({ getConfig }: { getConfig: <T = any>(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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getFilterBucketAgg.$1.getConfig",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ getConfig }",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getFilterBucketAgg.$1.getConfig.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"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"
|
|
},
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown, unknown, unknown, any>) | undefined) => Promise<",
|
|
"KibanaContextStartDependencies",
|
|
">) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ExpressionFunctionKibanaContext",
|
|
"text": "ExpressionFunctionKibanaContext"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown, unknown, unknown, any>) | undefined) => Promise<",
|
|
"KibanaContextStartDependencies",
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/max.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/median.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/min.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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",
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"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",
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getResponseInspectorStats",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getResponseInspectorStats",
|
|
"description": [],
|
|
"signature": [
|
|
"(resp: ",
|
|
"SearchResponse",
|
|
"<unknown> | 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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getResponseInspectorStats.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "resp",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchResponse",
|
|
"<unknown> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/inspect/inspector_stats.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getSearchParamsFromRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSearchParamsFromRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(searchRequest: Record<string, any>, 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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getSearchParamsFromRequest.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getSearchParamsFromRequest.$2.dependencies",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.getSearchParamsFromRequest.$2.dependencies.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string, defaultOverride?: T | undefined) => T"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.defaultOverride",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultOverride",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 73
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/sum.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 64
|
|
},
|
|
"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"
|
|
},
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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, }: ",
|
|
"RequestHandlerParams",
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"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}",
|
|
"description": [],
|
|
"signature": [
|
|
"RequestHandlerParams"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
", isDefaultTimezone: () => boolean, getConfig: <T = any>(key: string) => T) => string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.inferTimeZone.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.inferTimeZone.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isDefaultTimezone",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.inferTimeZone.$4",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string) => T"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/inject_references.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/inject_references.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.injectReferences.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/inject_references.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isAutoInterval",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isAutoInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: unknown) => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isAutoInterval.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isBucketAggType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isBucketAggType",
|
|
"description": [],
|
|
"signature": [
|
|
"(aggConfig: any) => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isBucketAggType.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined) => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/utils.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/utils.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isDateHistogramBucketAggConfig.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined) => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/utils.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/utils.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isMetricAggType.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "aggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfig",
|
|
"text": "AggConfig"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined) => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/utils.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"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"
|
|
},
|
|
"<any> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/utils.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfig",
|
|
"text": "AggConfig"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfig",
|
|
"text": "AggConfig"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isType.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isValidEsInterval.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [
|
|
"The interval string like 1w, 24h"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isValidInterval.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.isValidInterval.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "baseInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"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: ",
|
|
"Unit",
|
|
"; type: \"calendar\" | \"fixed\"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.parseEsInterval.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.parseInterval.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/parse_json.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.parseSearchSourceJSON.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchSourceJSON",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/parse_json.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/parse_time_shift.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.parseTimeShift.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/parse_time_shift.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.pollSearch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pollSearch",
|
|
"description": [],
|
|
"signature": [
|
|
"<Response extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any>>(search: () => Promise<Response>, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IAsyncSearchOptions",
|
|
"text": "IAsyncSearchOptions"
|
|
},
|
|
") => ",
|
|
"Observable",
|
|
"<Response>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/poll_search.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.pollSearch.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<Response>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/poll_search.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.pollSearch.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "cancel",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/poll_search.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/poll_search.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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) => <T extends { [key in P]: T[P]; }>(list: T[], filters?: string | string[] | FilterFunc<P, T>) => T[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.propFilter.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "prop",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"the filter function which can be registered with angular"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.queryToAst",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "queryToAst",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpressionBuilder",
|
|
"text": "ExpressionAstExpressionBuilder"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/query_to_ast.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.queryToAst.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/query_to_ast.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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: ",
|
|
"Unit",
|
|
"; } | null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.splitStringInterval.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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<string, any>, respOpts: Partial<",
|
|
"TabbedResponseWriterOptions",
|
|
"> | undefined) => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.tabifyAggResponse.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "esResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.tabifyAggResponse.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "respOpts",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
"TabbedResponseWriterOptions",
|
|
"> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.tabifyDocs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "tabifyDocs",
|
|
"description": [],
|
|
"signature": [
|
|
"(esResponse: ",
|
|
"SearchResponse",
|
|
"<unknown>, index?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | undefined, params?: ",
|
|
"TabifyDocsOptions",
|
|
") => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify_docs.ts",
|
|
"lineNumber": 74
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.tabifyDocs.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "esResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchResponse",
|
|
"<unknown>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify_docs.ts",
|
|
"lineNumber": 75
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.tabifyDocs.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "index",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify_docs.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.tabifyDocs.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"TabifyDocsOptions"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/tabify_docs.ts",
|
|
"lineNumber": 77
|
|
},
|
|
"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",
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/get_columns.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"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"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/get_columns.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/tabify/get_columns.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"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.ExpressionAstFunctionBuilder",
|
|
"text": "ExpressionAstFunctionBuilder"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ExpressionFunctionKibanaTimerange",
|
|
"text": "ExpressionFunctionKibanaTimerange"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange_to_ast.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigsOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AggConfigsOptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigsOptions.typesRegistry",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "typesRegistry",
|
|
"description": [],
|
|
"signature": [
|
|
"AggTypesRegistryStart"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggConfigsOptions.hierarchical",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hierarchical",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"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."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 196
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".FILTER>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: string | undefined; filter?: string | undefined; }, \"filter\">, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 197
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".FILTERS>, \"enabled\" | \"id\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ filters?: string | undefined; }, \"filters\"> & Pick<{ filters?: string | undefined; }, never>, \"enabled\" | \"filters\" | \"id\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 198
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 199
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".IP_RANGE>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, \"ipRangeType\" | \"ranges\"> & Pick<{ ranges?: string | undefined; ipRangeType?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 200
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".DATE_RANGE>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 201
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".RANGE>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\"> & Pick<{ ranges?: string | undefined; }, \"ranges\"> & Pick<{ ranges?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 202
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 203
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".GEOHASH_GRID>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"autoPrecision\" | \"precision\" | \"useGeocentroid\" | \"isFilteredByCollar\"> & Pick<{ boundingBox?: string | undefined; }, \"boundingBox\"> & Pick<{ boundingBox?: string | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 204
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".HISTOGRAM>, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"used_interval\" | \"maxBars\" | \"intervalBase\" | \"min_doc_count\" | \"has_extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, \"extended_bounds\"> & Pick<{ extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 205
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".DATE_HISTOGRAM>, \"enabled\" | \"interval\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"time_zone\" | \"used_interval\" | \"min_doc_count\" | \"useNormalizedEsInterval\" | \"scaleMetricValues\" | \"used_time_zone\" | \"drop_partials\" | \"format\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, \"timeRange\" | \"extended_bounds\"> & Pick<{ timeRange?: string | undefined; extended_bounds?: string | undefined; }, never>, \"enabled\" | \"interval\" | \"timeRange\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 206
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BUCKET_TYPES",
|
|
"text": "BUCKET_TYPES"
|
|
},
|
|
".TERMS>, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"field\" | \"orderBy\" | \"order\" | \"missingBucket\" | \"missingBucketLabel\" | \"otherBucket\" | \"otherBucketLabel\" | \"exclude\" | \"include\"> & Pick<{ orderAgg?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"orderAgg\"> & Pick<{ orderAgg?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"size\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 207
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 208
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".AVG_BUCKET>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 209
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".MAX_BUCKET>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 210
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".MIN_BUCKET>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 211
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".SUM_BUCKET>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 212
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".FILTERED_METRIC>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\" | \"customBucket\"> & Pick<{ customBucket?: ",
|
|
"AggExpressionType",
|
|
" | undefined; customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 213
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 214
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 215
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".CUMULATIVE_SUM>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 216
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".DERIVATIVE>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 217
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 218
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 219
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 220
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 221
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 222
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 223
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".MOVING_FN>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\" | \"window\" | \"script\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 224
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 225
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 226
|
|
},
|
|
"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<Pick<",
|
|
"AggExpressionFunctionArgs",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.METRIC_TYPES",
|
|
"text": "METRIC_TYPES"
|
|
},
|
|
".SERIAL_DIFF>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"timeShift\" | \"buckets_path\" | \"metricAgg\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, \"customMetric\"> & Pick<{ customMetric?: ",
|
|
"AggExpressionType",
|
|
" | undefined; }, never>, \"enabled\" | \"id\" | \"customLabel\" | \"schema\" | \"json\" | \"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 227
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 228
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 229
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 230
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamOption",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AggParamOption",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamOption.val",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamOption.display",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "display",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/avg.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsAvg.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/avg.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsCardinality.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsCumulativeSum.buckets_path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buckets_path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsCumulativeSum.metricAgg",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "metricAgg",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.field",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"string | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.useNormalizedEsInterval",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useNormalizedEsInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 64
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.scaleMetricValues",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "scaleMetricValues",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.interval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 66
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.used_interval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "used_interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 67
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.time_zone",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "time_zone",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 68
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.used_time_zone",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "used_time_zone",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 69
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.drop_partials",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "drop_partials",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 70
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.format",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 71
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.min_doc_count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "min_doc_count",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateHistogram.extended_bounds",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "extended_bounds",
|
|
"description": [],
|
|
"signature": [
|
|
"ExtendedBounds",
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 73
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateRange.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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.DateRangeKey",
|
|
"text": "DateRangeKey"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDateRange.time_zone",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "time_zone",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/derivative.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDerivative.buckets_path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buckets_path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/derivative.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/derivative.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsDerivative.metricAgg",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "metricAgg",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/derivative.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsFilter.geo_bounding_box",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "geo_bounding_box",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsFilters.filters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [],
|
|
"signature": [
|
|
"{ input: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
"; label: string; }[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoBounds.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoCentroid.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoHash.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoHash.autoPrecision",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "autoPrecision",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoHash.precision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "precision",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoHash.useGeocentroid",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useGeocentroid",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoHash.isFilteredByCollar",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isFilteredByCollar",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoHash.boundingBox",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "boundingBox",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoTile.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoTile.useGeocentroid",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useGeocentroid",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsGeoTile.precision",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "precision",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.interval",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.used_interval",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "used_interval",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.maxBars",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxBars",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.intervalBase",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "intervalBase",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.min_doc_count",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "min_doc_count",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.has_extended_bounds",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "has_extended_bounds",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsHistogram.extended_bounds",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "extended_bounds",
|
|
"description": [],
|
|
"signature": [
|
|
"ExtendedBounds",
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsIpRange.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/max.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsMax.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/max.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/median.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsMedian.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/median.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/min.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsMin.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/min.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsMovingAvg.buckets_path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buckets_path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsMovingAvg.window",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "window",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsMovingAvg.script",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "script",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsMovingAvg.metricAgg",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "metricAgg",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsPercentileRanks.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsPercentileRanks.values",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "values",
|
|
"description": [],
|
|
"signature": [
|
|
"number[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsPercentiles.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsPercentiles.percents",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "percents",
|
|
"description": [],
|
|
"signature": [
|
|
"number[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsRange.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsRange.ranges",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "ranges",
|
|
"description": [],
|
|
"signature": [
|
|
"{ from: number; to: number; label?: string | undefined; }[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSerialDiff.buckets_path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buckets_path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSerialDiff.metricAgg",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "metricAgg",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSignificantTerms.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSignificantTerms.size",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSignificantTerms.exclude",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "exclude",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSignificantTerms.include",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "include",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSinglePercentile.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSinglePercentile.percentile",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "percentile",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/single_percentile.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsStdDeviation.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/sum.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsSum.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/sum.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.orderBy",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "orderBy",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"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?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; } | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.order",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [],
|
|
"signature": [
|
|
"\"asc\" | \"desc\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.size",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.missingBucket",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "missingBucket",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.missingBucketLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "missingBucketLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.otherBucket",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "otherBucket",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.otherBucketLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "otherBucketLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.exclude",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "exclude",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTerms.include",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "include",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTopHit.field",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTopHit.aggregate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "aggregate",
|
|
"description": [],
|
|
"signature": [
|
|
"\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTopHit.sortField",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sortField",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTopHit.size",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggParamsTopHit.sortOrder",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sortOrder",
|
|
"description": [],
|
|
"signature": [
|
|
"\"asc\" | \"desc\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
},
|
|
"<TAggConfig, TParam>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.createFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.dslName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "dslName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.expressionName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "expressionName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.makeLabel",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "makeLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"((aggConfig: TAggConfig) => string) | (() => string) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.ordered",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "ordered",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.hasNoDsl",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hasNoDsl",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.hasNoDslParams",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hasNoDslParams",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.params",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TParam>[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.valueType",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "valueType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"_source\" | \"ip\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.getRequestAggs",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "getRequestAggs",
|
|
"description": [],
|
|
"signature": [
|
|
"((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.getResponseAggs",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "getResponseAggs",
|
|
"description": [],
|
|
"signature": [
|
|
"((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.customLabels",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "customLabels",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.json",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "json",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.decorateAggConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "decorateAggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => any) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.postFlightRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "postFlightRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"PostFlightRequestFn<TAggConfig> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.getSerializedFormat",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSerializedFormat",
|
|
"description": [],
|
|
"signature": [
|
|
"((agg: TAggConfig) => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.getValue",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getValue",
|
|
"description": [],
|
|
"signature": [
|
|
"((agg: TAggConfig, bucket: any) => any) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.getKey",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getKey",
|
|
"description": [],
|
|
"signature": [
|
|
"((bucket: any, key: any, agg: TAggConfig) => any) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypeConfig.getValueBucketPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getValueBucketPath",
|
|
"description": [],
|
|
"signature": [
|
|
"((agg: TAggConfig) => string) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AutoBounds",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AutoBounds",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AutoBounds.min",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "min",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AutoBounds.max",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "max",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"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"
|
|
},
|
|
"<TBucketAggConfig> extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggParamType",
|
|
"text": "AggParamType"
|
|
},
|
|
"<TBucketAggConfig>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggParam.scriptable",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "scriptable",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BucketAggParam.filterFieldTypes",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "filterFieldTypes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
" | \"*\" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMaskIpRangeAggKey",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CidrMaskIpRangeAggKey",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMaskIpRangeAggKey.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"mask\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.CidrMaskIpRangeAggKey.mask",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "mask",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateHistogramBucketAggDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DateHistogramBucketAggDependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isDefaultTimezone",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateHistogramBucketAggDependencies.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string) => T"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateRangeBucketAggDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DateRangeBucketAggDependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isDefaultTimezone",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateRangeBucketAggDependencies.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string) => T"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateRangeKey",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DateRangeKey",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateRangeKey.from",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "from",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts",
|
|
"lineNumber": 10
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.DateRangeKey.to",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "to",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.EqlRequestParams",
|
|
"text": "EqlRequestParams"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.EqlSearchStrategyRequest.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"TransportRequestOptions",
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
},
|
|
"<T>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.EsRawResponse.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"es_raw_response\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.EsRawResponse.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchResponse",
|
|
"<T>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FetchHandlers",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FetchHandlers",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FetchHandlers.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string, defaultOverride?: T | undefined) => T"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.defaultOverride",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultOverride",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"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<string, any>, response: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any>) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.request",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.response",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FiltersBucketAggDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FiltersBucketAggDependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FiltersBucketAggDependencies.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.HistogramBucketAggDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HistogramBucketAggDependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.HistogramBucketAggDependencies.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = any>(key: string) => T"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldFormatsStart",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Pick<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsRegistry",
|
|
"text": "FieldFormatsRegistry"
|
|
},
|
|
", \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\">, \"deserialize\" | \"getDefaultInstance\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IBucketDateHistogramAggConfig.buckets",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "buckets",
|
|
"description": [],
|
|
"signature": [
|
|
"TimeBuckets"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.bounds",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bounds",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AutoBounds",
|
|
"text": "AutoBounds"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/es_search/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IEsSearchRequest.indexType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "indexType",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/es_search/types.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IInspectorInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IInspectorInfo",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 88
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 89
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IInspectorInfo.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IInspectorInfo.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 91
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IInspectorInfo.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"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"
|
|
},
|
|
"<Params>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 79
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 83
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IKibanaSearchRequest.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Params | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 85
|
|
},
|
|
"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"
|
|
},
|
|
"<RawResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 66
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 71
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ISearchClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISearchClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ISearchClient.search",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"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"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(request: SearchStrategyRequest, options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => ",
|
|
"Observable",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.request",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchStrategyRequest"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"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<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.keepAlive",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keepAlive",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ISearchOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISearchOptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 99
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 104
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 110
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 115
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 120
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 126
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 131
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 136
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ISearchStartSearchSource",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISearchStartSearchSource",
|
|
"description": [
|
|
"\nhigh level search service"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"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<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\">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fields",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fields",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IStdDevAggConfig.keyedDetails",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "keyedDetails",
|
|
"description": [],
|
|
"signature": [
|
|
"(customLabel: string, fieldDisplayName?: string | undefined) => Record<string, ValProp>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.customLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "customLabel",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldDisplayName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fieldDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IStdDevAggConfig.valProp",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "valProp",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
"<TMetricAggConfig> extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggParamType",
|
|
"text": "AggParamType"
|
|
},
|
|
"<TMetricAggConfig>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggParam.filterFieldTypes",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "filterFieldTypes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
" | \"*\" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MetricAggParam.onlyAggregatable",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "onlyAggregatable",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MsearchRequestBody",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MsearchRequestBody",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/legacy/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MsearchRequestBody.searches",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "searches",
|
|
"description": [],
|
|
"signature": [
|
|
"MsearchRequest[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/legacy/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MsearchResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MsearchResponse",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/legacy/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.MsearchResponse.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"ApiResponse",
|
|
"<{ responses: ",
|
|
"SearchResponse",
|
|
"<any>[]; }, unknown>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/legacy/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.OptionedValueProp",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OptionedValueProp",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.OptionedValueProp.value",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.OptionedValueProp.text",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "text",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.OptionedValueProp.disabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "disabled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.agg",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "agg",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfig",
|
|
"text": "AggConfig"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/optioned.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.PercentileRanksMetricAggDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PercentileRanksMetricAggDependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldFormatsStart",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Pick<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsRegistry",
|
|
"text": "FieldFormatsRegistry"
|
|
},
|
|
", \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\">, \"deserialize\" | \"getDefaultInstance\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.RangeBucketAggDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RangeBucketAggDependencies",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.RangeBucketAggDependencies.getFieldFormatsStart",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldFormatsStart",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Pick<Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsRegistry",
|
|
"text": "FieldFormatsRegistry"
|
|
},
|
|
", \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\">, \"deserialize\" | \"getDefaultInstance\">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.RangeIpRangeAggKey",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RangeIpRangeAggKey",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.RangeIpRangeAggKey.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"range\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.RangeIpRangeAggKey.from",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "from",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.RangeIpRangeAggKey.to",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "to",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.Request",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Request",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 131
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.Request.docvalue_fields",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "docvalue_fields",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 132
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.Request._source",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "_source",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 133
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.Request.query",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 134
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.Request.script_fields",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "script_fields",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 135
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.Request.sort",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "sort",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 136
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.Request.stored_fields",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "stored_fields",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 137
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ResponseWithShardFailure",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ResponseWithShardFailure",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 140
|
|
},
|
|
"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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 141
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchError",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchError.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchError.status",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchError.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchError.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchError.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/fetch/types.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionFindOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchSessionFindOptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionFindOptions.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 96
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionFindOptions.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 97
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionFindOptions.sortField",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sortField",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 98
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionFindOptions.sortOrder",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sortOrder",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 99
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionFindOptions.filter",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "filter",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 100
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionRequestInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchSessionRequestInfo",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 76
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionRequestInfo.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nID of the async search request"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 80
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionRequestInfo.strategy",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "strategy",
|
|
"description": [
|
|
"\nSearch strategy used to submit the search request"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 84
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionRequestInfo.status",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"\nstatus"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 88
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionSavedObjectAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchSessionSavedObjectAttributes",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionSavedObjectAttributes.sessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sessionId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionSavedObjectAttributes.created",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "created",
|
|
"description": [
|
|
"\nCreation time of the session"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionSavedObjectAttributes.touched",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "touched",
|
|
"description": [
|
|
"\nLast touch time of the session"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"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."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionSavedObjectAttributes.urlGeneratorId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "urlGeneratorId",
|
|
"description": [
|
|
"\nurlGeneratorId"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"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": [
|
|
"Record<string, unknown> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"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": [
|
|
"Record<string, unknown> | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"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"
|
|
},
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"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."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 67
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 71
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionSavedObjectAttributes.realmName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "realmName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionSavedObjectAttributes.username",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "username",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 73
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 122
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceDependencies.search",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"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"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(request: SearchStrategyRequest, options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => ",
|
|
"Observable",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
|
"lineNumber": 123
|
|
},
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.request",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchStrategyRequest"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchSourceFields",
|
|
"description": [
|
|
"\nsearch source fields"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 70
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 71
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [
|
|
"\n{@link Query}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 75
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.filter",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "filter",
|
|
"description": [
|
|
"\n{@link Filter}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | (() => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined) | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 79
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.sort",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sort",
|
|
"description": [
|
|
"\n{@link EsQuerySortValue}"
|
|
],
|
|
"signature": [
|
|
"Record<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"
|
|
},
|
|
"> | Record<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"
|
|
},
|
|
">[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 83
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.highlight",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "highlight",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 84
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.highlightAll",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "highlightAll",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 85
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.trackTotalHits",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "trackTotalHits",
|
|
"description": [],
|
|
"signature": [
|
|
"number | boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 86
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 90
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.from",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "from",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 91
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.size",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 92
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.source",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [],
|
|
"signature": [
|
|
"string | boolean | string[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 93
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.version",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 94
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 98
|
|
},
|
|
"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 | boolean | string[] | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 104
|
|
},
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "reporting",
|
|
"link": {
|
|
"path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts",
|
|
"lineNumber": 150
|
|
}
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"link": {
|
|
"path": "x-pack/plugins/reporting/server/export_types/csv_searchsource/generate_csv/generate_csv.ts",
|
|
"lineNumber": 152
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.index",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "index",
|
|
"description": [
|
|
"\n{@link IndexPatternService}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 108
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 109
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.timeout",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeout",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 110
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceFields.terminate_after",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "terminate_after",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 111
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 113
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SearchSourceOptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 116
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSourceOptions.callParentStartHandlers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "callParentStartHandlers",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 117
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ShardFailure",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShardFailure",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 150
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ShardFailure.index",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "index",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 151
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ShardFailure.node",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "node",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 152
|
|
},
|
|
"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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 153
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ShardFailure.shard",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "shard",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 164
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortDirectionFormat",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SortDirectionFormat",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortDirectionFormat.format",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortDirectionNumeric",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SortDirectionNumeric",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortDirectionNumeric.numeric_type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "numeric_type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SortOptions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 120
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions.mode",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "mode",
|
|
"description": [],
|
|
"signature": [
|
|
"\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 121
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 122
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions.nested",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "nested",
|
|
"description": [],
|
|
"signature": [
|
|
"object | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 123
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions.unmapped_type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "unmapped_type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 124
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions.distance_type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "distance_type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"arc\" | \"plane\" | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 125
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions.unit",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "unit",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 126
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions.ignore_unmapped",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ignore_unmapped",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 127
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortOptions._script",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "_script",
|
|
"description": [],
|
|
"signature": [
|
|
"object | undefined"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 128
|
|
},
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.BUCKET_TYPES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "BUCKET_TYPES",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IP_RANGE_TYPES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "IP_RANGE_TYPES",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.METRIC_TYPES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "METRIC_TYPES",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchSessionStatus",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "SearchSessionStatus",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/status.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SortDirection",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "SortDirection",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggAvgFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggAvgFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggAvg\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketAvgFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggBucketAvgFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggBucketAvg\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketMaxFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggBucketMaxFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggBucketMax\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketMinFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggBucketMinFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggBucketMin\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggBucketSumFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggBucketSumFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggBucketSum\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggCardinalityFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggCardinalityFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggCardinality\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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"
|
|
},
|
|
"; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggCountFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggCountFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggCount\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggCumulativeSumFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggCumulativeSumFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggCumulativeSum\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggDateHistogramFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggDateHistogramFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggDateHistogram\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggDateRangeFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggDateRangeFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggDateRange\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggDerivativeFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggDerivativeFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggDerivative\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggFilteredMetricFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggFilteredMetricFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggFilteredMetric\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/filtered_metric_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggFilterFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggFilterFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggFilter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggFiltersFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggFiltersFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggFilters\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoBoundsFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggGeoBoundsFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggGeoBounds\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoCentroidFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggGeoCentroidFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggGeoCentroid\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoHashFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggGeoHashFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggGeoHash\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggGeoTileFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggGeoTileFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggGeoTile\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggGroupName",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AggGroupName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"none\" | \"buckets\" | \"metrics\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggHistogramFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggHistogramFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggHistogram\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggIpRangeFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggIpRangeFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggIpRange\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMaxFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggMaxFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggMax\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMedianFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggMedianFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggMedian\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMinFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggMinFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggMin\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggMovingAvgFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggMovingAvgFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggMovingAvg\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_params.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggPercentileRanksFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggPercentileRanksFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggPercentileRanks\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggPercentilesFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggPercentilesFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggPercentiles\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggRangeFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggRangeFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggRange\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSerialDiffFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggSerialDiffFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggSerialDiff\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSignificantTermsFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggSignificantTermsFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggSignificantTerms\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSinglePercentileFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggSinglePercentileFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggSinglePercentile\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/single_percentile_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
", configStates?: Pick<Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\" | \"params\"> & 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\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
},
|
|
"; types: ",
|
|
"AggTypesRegistryStart",
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/types.ts",
|
|
"lineNumber": 129
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggStdDeviationFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggStdDeviationFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggStdDeviation\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggSumFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggSumFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggSum\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggTermsFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggTermsFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggTerms\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.aggTopHitFnName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggTopHitFnName",
|
|
"description": [],
|
|
"signature": [
|
|
"\"aggTopHit\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggTypesRegistrySetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AggTypesRegistrySetup",
|
|
"description": [],
|
|
"signature": [
|
|
"{ registerBucket: <N extends string, T extends (deps: ",
|
|
"AggTypesDependencies",
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.BucketAggType",
|
|
"text": "BucketAggType"
|
|
},
|
|
"<any>>(name: N, type: T) => void; registerMetric: <N extends string, T extends (deps: ",
|
|
"AggTypesDependencies",
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.MetricAggType",
|
|
"text": "MetricAggType"
|
|
},
|
|
"<any>>(name: N, type: T) => void; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_types_registry.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.autoInterval",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "autoInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"\"auto\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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; })[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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"
|
|
},
|
|
"; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ",
|
|
"SerializableState",
|
|
" | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ENHANCED_ES_SEARCH_STRATEGY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENHANCED_ES_SEARCH_STRATEGY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ese\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/ese_search/types.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.EQL_SEARCH_STRATEGY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "EQL_SEARCH_STRATEGY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"eql\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.EqlRequestParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EqlRequestParams",
|
|
"description": [],
|
|
"signature": [
|
|
"EqlSearch",
|
|
"<Record<string, unknown>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"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"
|
|
},
|
|
"<",
|
|
"ApiResponse",
|
|
"<T, unknown>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/eql_search/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ES_SEARCH_STRATEGY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ES_SEARCH_STRATEGY",
|
|
"description": [],
|
|
"signature": [
|
|
"\"es\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/es_search/types.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/esdsl.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.EsQuerySearchAfter",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EsQuerySearchAfter",
|
|
"description": [],
|
|
"signature": [
|
|
"[React.ReactText, React.ReactText]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"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"
|
|
},
|
|
"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown>, ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.EsRawResponse",
|
|
"text": "EsRawResponse"
|
|
},
|
|
"<unknown>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ExecutionContextSearch",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExecutionContextSearch",
|
|
"description": [],
|
|
"signature": [
|
|
"{ filters?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined; query?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
"[] | undefined; timeRange?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"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"
|
|
},
|
|
", ",
|
|
"SerializableState",
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.FieldTypes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldTypes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
" | \"*\" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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",
|
|
"<any> & { [property: string]: ",
|
|
"AggregationsAggregate",
|
|
"; }) | ({ [property: string]: ",
|
|
"AggregationsAggregate",
|
|
"; } & { [property: string]: ",
|
|
"AggregationsAggregate",
|
|
"; }) | (",
|
|
"AggregationsSignificantTermsBucketKeys",
|
|
"<any> & { [property: string]: ",
|
|
"AggregationsAggregate",
|
|
"; }) | ({ [property: string]: ",
|
|
"AggregationsAggregate",
|
|
"; } & { [property: string]: ",
|
|
"AggregationsAggregate",
|
|
"; }) | (",
|
|
"AggregationsKeyedBucketKeys",
|
|
"<any> & { [property: string]: ",
|
|
"AggregationsAggregate",
|
|
"; })"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"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",
|
|
"<Source>>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/es_search/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/param_types/field.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"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; })[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IPercentileAggConfig",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IPercentileAggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"IResponseAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.IPercentileRanksAggConfig",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IPercentileRanksAggConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"IResponseAggConfig"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"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<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"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<void>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ISearchGeneric",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ISearchGeneric",
|
|
"description": [],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"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"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(request: SearchStrategyRequest, options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => ",
|
|
"Observable",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"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": [
|
|
"{ isStored?: boolean | undefined; isRestore?: boolean | undefined; sessionId?: string | undefined; strategy?: string | undefined; legacyHitsTotal?: boolean | undefined; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/types.ts",
|
|
"lineNumber": 143
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ISearchRequestParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ISearchRequestParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ trackTotalHits?: boolean | undefined; } & ",
|
|
"SearchRequest"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/strategies/es_search/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"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<string, any>[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(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: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; setFields: (newFields: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; getId: () => string; getFields: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"; getField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, recurse?: boolean) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]; getOwnField: <K extends \"type\" | \"from\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(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",
|
|
"<any>>>; fetch: (options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
") => Promise<",
|
|
"SearchResponse",
|
|
"<any>>; 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<unknown>) => 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",
|
|
"[]; }; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.KIBANA_CONTEXT_NAME",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KIBANA_CONTEXT_NAME",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_context\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.KibanaField",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaField",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: \"kibana_field\"; } & ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.KibanaFilter",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: \"kibana_filter\"; } & ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.KibanaQueryOutput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaQueryOutput",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: \"kibana_query\"; } & ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.KibanaRange",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaRange",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: \"kibana_range\"; } & Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.parentPipelineType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "parentPipelineType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.ParsedInterval",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ParsedInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"{ value: number; unit: ",
|
|
"Unit",
|
|
"; type: \"calendar\" | \"fixed\"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SEARCH_SESSION_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SEARCH_SESSION_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"search-session\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/types.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SEARCH_SESSIONS_TABLE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SEARCH_SESSIONS_TABLE_ID",
|
|
"description": [],
|
|
"signature": [
|
|
"\"searchSessionsMgmtUiTable\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/session/index.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.SearchFieldValue",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SearchFieldValue",
|
|
"description": [],
|
|
"signature": [
|
|
"string | SearchField"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/search_source/types.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.siblingPipelineType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "siblingPipelineType",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.termsAggFilter",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "termsAggFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/terms.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggGroupLabels",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "AggGroupLabels",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggGroupLabels.AggGroupNames.Buckets",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[AggGroupNames.Buckets]",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggGroupLabels.AggGroupNames.Metrics",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[AggGroupNames.Metrics]",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.AggGroupLabels.AggGroupNames.None",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "[AggGroupNames.None]",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"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\"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/agg_groups.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.esRawResponse",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "esRawResponse",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 63
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.esRawResponse.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"es_raw_response\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 64
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.esRawResponse.to",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "to",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown>) => { 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[]; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 66
|
|
},
|
|
"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"
|
|
},
|
|
"<unknown>"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/es_raw_response.ts",
|
|
"lineNumber": 66
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "existsFilterFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"existsFilter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_filter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.field",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.field.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_field\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.field.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.field.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.negate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "negate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.negate.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.negate.default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "default",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.args.negate.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.fn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fn",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: null, args: Arguments) => { $state?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.FilterState",
|
|
"text": "FilterState"
|
|
},
|
|
" | undefined; meta: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.FilterMeta",
|
|
"text": "FilterMeta"
|
|
},
|
|
"; query?: any; type: \"kibana_filter\"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.existsFilterFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/exists_filter.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fieldFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"field\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_field\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.name",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.name.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.name.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.name.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.type",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 41
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.type.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.type.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.type.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.script",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "script",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.script.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.args.script.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.fieldFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/field.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kibana",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_context\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"kibana_context\" | \"null\")[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana.fn.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"Input"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibana.fn.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "_",
|
|
"description": [],
|
|
"signature": [
|
|
"object"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kibanaContext",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaContext.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaContext.from",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "from",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaContext.from.null",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "null",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { type: string; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaContext.to",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "to",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaContext.to.null",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "null",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { type: string; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kibanaFilterFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibanaFilter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_filter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.query.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.query.aliases",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "aliases",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.query.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.query.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.negate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "negate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.negate.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.negate.default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "default",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.negate.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.disabled",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "disabled",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.disabled.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.disabled.default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "default",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.args.disabled.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.fn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fn",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: null, args: Arguments) => any"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaFilterFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kibanaTimerangeFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"timerange\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"timerange\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.from",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "from",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.from.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.from.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.from.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.to",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "to",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.to.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.to.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.to.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.mode",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mode",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.mode.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.mode.options",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"absolute\" | \"relative\")[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.args.mode.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kibanaTimerangeFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/timerange.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kqlFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kql\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_query\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.args.q",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "q",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.args.q.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.args.q.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.args.q.aliases",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "aliases",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.args.q.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.kqlFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/kql.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "luceneFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 24
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"lucene\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_query\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.args.q",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "q",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.args.q.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.args.q.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 34
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.args.q.aliases",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "aliases",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.args.q.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.luceneFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/lucene.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"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": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.KBN_FIELD_TYPES",
|
|
"text": "KBN_FIELD_TYPES"
|
|
},
|
|
" | \"*\" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.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?: {} | ",
|
|
"SerializableState",
|
|
" | 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<string, any>, aggConfigs?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
},
|
|
" | undefined, locals?: Record<string, any> | 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"
|
|
},
|
|
" | 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; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.parentPipelineAggHelper",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parentPipelineAggHelper",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.parentPipelineAggHelper.subtype",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "subtype",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"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"
|
|
},
|
|
">[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "phraseFilterFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"rangeFilter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_filter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.field",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.field.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_field\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.field.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.field.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.phrase",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "phrase",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.phrase.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"string\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.phrase.multi",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "multi",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.phrase.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.phrase.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.negate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "negate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.negate.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.negate.default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "default",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.args.negate.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.fn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fn",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: null, args: Arguments) => { $state?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.FilterState",
|
|
"text": "FilterState"
|
|
},
|
|
" | undefined; meta: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.FilterMeta",
|
|
"text": "FilterMeta"
|
|
},
|
|
"; query?: any; type: \"kibana_filter\"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.phraseFilterFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/phrase_filter.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "rangeFilterFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"rangeFilter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_filter\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.field",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.field.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_field\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.field.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.field.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 40
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.range",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "range",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.range.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_range\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 45
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.range.required",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "required",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.range.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 47
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.negate",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "negate",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 51
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.negate.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"\"boolean\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.negate.default",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "default",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.args.negate.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.fn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fn",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: null, args: Arguments) => { $state?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.FilterState",
|
|
"text": "FilterState"
|
|
},
|
|
" | undefined; meta: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-common.FilterMeta",
|
|
"text": "FilterMeta"
|
|
},
|
|
"; query?: any; type: \"kibana_filter\"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFilterFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range_filter.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "rangeFunction",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"range\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"kibana_range\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.inputTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"\"null\"[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 32
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.gt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "gt",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.gt.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"number\" | \"string\")[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 37
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.gt.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 38
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.lt",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lt",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.lt.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"number\" | \"string\")[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.lt.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.gte",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "gte",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 48
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.gte.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"number\" | \"string\")[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 49
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.gte.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 50
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.lte",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lte",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 54
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.lte.types",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "types",
|
|
"description": [],
|
|
"signature": [
|
|
"(\"number\" | \"string\")[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 55
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.args.lte.help",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "help",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 56
|
|
},
|
|
"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\"; }"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.fn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"null"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.rangeFunction.fn.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"Arguments"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/expressions/range.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.siblingPipelineAggHelper",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "siblingPipelineAggHelper",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts",
|
|
"lineNumber": 42
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.siblingPipelineAggHelper.subtype",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "subtype",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts",
|
|
"lineNumber": 43
|
|
},
|
|
"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"
|
|
},
|
|
">[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "data",
|
|
"id": "def-common.siblingPipelineAggHelper.params.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "bucketFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"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"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts",
|
|
"lineNumber": 80
|
|
},
|
|
"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"
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts",
|
|
"lineNumber": 80
|
|
},
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |