mirror of
https://github.com/elastic/kibana.git
synced 2025-04-19 15:35:00 -04:00
37777 lines
No EOL
1.3 MiB
37777 lines
No EOL
1.3 MiB
{
|
|
"id": "core",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ToastsApi",
|
|
"description": [
|
|
"\nMethods for adding and removing global toast messages."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastsApi",
|
|
"text": "ToastsApi"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.IToasts",
|
|
"text": "IToasts"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.Unnamed.$1.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"IUiSettingsClient"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.get$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get$",
|
|
"description": [
|
|
"Observable of the toast messages to show to the user."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.add",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "add",
|
|
"description": [
|
|
"\nAdds a new toast to current array of toast.\n"
|
|
],
|
|
"signature": [
|
|
"(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"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.add.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "toastOrTitle",
|
|
"description": [
|
|
"- a {@link ToastInput }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a {@link Toast }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.remove",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "remove",
|
|
"description": [
|
|
"\nRemoves a toast from the current array of toasts if present."
|
|
],
|
|
"signature": [
|
|
"(toastOrId: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.remove.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "toastOrId",
|
|
"description": [
|
|
"- a {@link Toast } returned by {@link ToastsApi.add } or its id"
|
|
],
|
|
"signature": [
|
|
"string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Toast",
|
|
"text": "Toast"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addInfo",
|
|
"description": [
|
|
"\nAdds a new toast pre-configured with the info color and info icon.\n"
|
|
],
|
|
"signature": [
|
|
"(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"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addInfo.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "toastOrTitle",
|
|
"description": [
|
|
"- a {@link ToastInput }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addInfo.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- a {@link ToastOptions }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a {@link Toast }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addSuccess",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addSuccess",
|
|
"description": [
|
|
"\nAdds a new toast pre-configured with the success color and check icon.\n"
|
|
],
|
|
"signature": [
|
|
"(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"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addSuccess.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "toastOrTitle",
|
|
"description": [
|
|
"- a {@link ToastInput }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addSuccess.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- a {@link ToastOptions }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a {@link Toast }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addWarning",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addWarning",
|
|
"description": [
|
|
"\nAdds a new toast pre-configured with the warning color and help icon.\n"
|
|
],
|
|
"signature": [
|
|
"(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"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addWarning.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "toastOrTitle",
|
|
"description": [
|
|
"- a {@link ToastInput }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addWarning.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- a {@link ToastOptions }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a {@link Toast }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addDanger",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addDanger",
|
|
"description": [
|
|
"\nAdds a new toast pre-configured with the danger color and alert icon.\n"
|
|
],
|
|
"signature": [
|
|
"(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"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addDanger.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "toastOrTitle",
|
|
"description": [
|
|
"- a {@link ToastInput }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInput",
|
|
"text": "ToastInput"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addDanger.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- a {@link ToastOptions }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a {@link Toast }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addError",
|
|
"description": [
|
|
"\nAdds a new toast that displays an exception message with a button to open the full stacktrace in a modal.\n"
|
|
],
|
|
"signature": [
|
|
"(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"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"- an `Error` instance."
|
|
],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsApi.addError.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- {@link ErrorToastOptions }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ErrorToastOptions",
|
|
"text": "ErrorToastOptions"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a {@link Toast }"
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AnalyticsClient",
|
|
"description": [
|
|
"\nAnalytics client's public APIs"
|
|
],
|
|
"signature": [
|
|
"AnalyticsClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.reportEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportEvent",
|
|
"description": [
|
|
"\nReports a telemetry event."
|
|
],
|
|
"signature": [
|
|
"<EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.reportEvent.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "eventType",
|
|
"description": [
|
|
"The event type registered via the `registerEventType` API."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.reportEvent.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "eventData",
|
|
"description": [
|
|
"The properties matching the schema declared in the `registerEventType` API."
|
|
],
|
|
"signature": [
|
|
"EventTypeData"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerEventType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEventType",
|
|
"description": [
|
|
"\nRegisters the event type that will be emitted via the reportEvent API."
|
|
],
|
|
"signature": [
|
|
"<EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerEventType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "eventTypeOps",
|
|
"description": [
|
|
"The definition of the event type {@link EventTypeOpts }."
|
|
],
|
|
"signature": [
|
|
"EventTypeOpts",
|
|
"<EventTypeData>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerShipper",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerShipper",
|
|
"description": [
|
|
"\nSet up the shipper that will be used to report the telemetry events."
|
|
],
|
|
"signature": [
|
|
"<Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerShipper.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "Shipper",
|
|
"description": [
|
|
"The {@link IShipper } class to instantiate the shipper."
|
|
],
|
|
"signature": [
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerShipper.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "shipperConfig",
|
|
"description": [
|
|
"The config specific to the Shipper to instantiate."
|
|
],
|
|
"signature": [
|
|
"ShipperConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerShipper.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [
|
|
"Additional options to register the shipper {@link RegisterShipperOpts }."
|
|
],
|
|
"signature": [
|
|
"RegisterShipperOpts",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.optIn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "optIn",
|
|
"description": [
|
|
"\nUsed to control the user's consent to report the data.\nIn the advanced mode, it allows to \"cherry-pick\" which events and shippers are enabled/disabled."
|
|
],
|
|
"signature": [
|
|
"(optInConfig: ",
|
|
"OptInConfig",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.optIn.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "optInConfig",
|
|
"description": [
|
|
"{@link OptInConfig }"
|
|
],
|
|
"signature": [
|
|
"OptInConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerContextProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerContextProvider",
|
|
"description": [
|
|
"\nRegisters the context provider to enrich the any reported events."
|
|
],
|
|
"signature": [
|
|
"<Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.registerContextProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contextProviderOpts",
|
|
"description": [
|
|
"{@link ContextProviderOpts }"
|
|
],
|
|
"signature": [
|
|
"ContextProviderOpts",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.removeContextProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeContextProvider",
|
|
"description": [
|
|
"\nRemoves the context provider and stop enriching the events from its context."
|
|
],
|
|
"signature": [
|
|
"(contextProviderName: string) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.removeContextProvider.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "contextProviderName",
|
|
"description": [
|
|
"The name of the context provider to remove."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.telemetryCounter$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryCounter$",
|
|
"description": [
|
|
"\nObservable to emit the stats of the processed events."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsClient.shutdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shutdown",
|
|
"description": [
|
|
"\nStops the client."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AppCategory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AppCategory",
|
|
"description": [
|
|
"\n\nA category definition for nav links to know where to sort them in the left hand nav"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AppCategory.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nUnique identifier for the categories"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AppCategory.label",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "label",
|
|
"description": [
|
|
"\nLabel used for category name.\nAlso used as aria-label if one isn't set."
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AppCategory.ariaLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ariaLabel",
|
|
"description": [
|
|
"\nIf the visual label isn't appropriate for screen readers,\ncan override it here"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AppCategory.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [
|
|
"\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AppCategory.euiIconType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "euiIconType",
|
|
"description": [
|
|
"\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Capabilities",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Capabilities",
|
|
"description": [
|
|
"\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n"
|
|
],
|
|
"signature": [
|
|
"Capabilities"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Capabilities.navLinks",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "navLinks",
|
|
"description": [
|
|
"Navigation link capabilities."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: boolean; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Capabilities.management",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "management",
|
|
"description": [
|
|
"Management section capabilities."
|
|
],
|
|
"signature": [
|
|
"{ [sectionId: string]: Record<string, boolean>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Capabilities.catalogue",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "catalogue",
|
|
"description": [
|
|
"Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: boolean; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Capabilities.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: Record<string, boolean | Record<string, boolean>>",
|
|
"description": [
|
|
"Custom capabilities, registered by plugins."
|
|
],
|
|
"signature": [
|
|
"[key: string]: Record<string, boolean | Record<string, boolean>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ContextProviderOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ContextProviderOpts",
|
|
"description": [
|
|
"\nDefinition of a context provider"
|
|
],
|
|
"signature": [
|
|
"ContextProviderOpts",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ContextProviderOpts.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nThe name of the provider."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ContextProviderOpts.context$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context$",
|
|
"description": [
|
|
"\nObservable that emits the custom context."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ContextProviderOpts.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [
|
|
"\nSchema declaring and documenting the expected output in the context$\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<Context>]: ",
|
|
"SchemaValue",
|
|
"<Context[Key]>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CoreSetup",
|
|
"description": [
|
|
"\nCore services exposed to the `Plugin` setup lifecycle\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<TPluginsStart, TStart>"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.analytics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analytics",
|
|
"description": [
|
|
"{@link AnalyticsServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.application",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "application",
|
|
"description": [
|
|
"{@link ApplicationSetup}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ApplicationSetup",
|
|
"text": "ApplicationSetup"
|
|
}
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.fatalErrors",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fatalErrors",
|
|
"description": [
|
|
"{@link FatalErrorsSetup}"
|
|
],
|
|
"signature": [
|
|
"FatalErrorsSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [
|
|
"{@link HttpSetup}"
|
|
],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.notifications",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "notifications",
|
|
"description": [
|
|
"{@link NotificationsSetup}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.NotificationsSetup",
|
|
"text": "NotificationsSetup"
|
|
}
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [
|
|
"{@link IUiSettingsClient}"
|
|
],
|
|
"signature": [
|
|
"IUiSettingsClient"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.executionContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionContext",
|
|
"description": [
|
|
"{@link ExecutionContextSetup}"
|
|
],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.injectedMetadata",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "injectedMetadata",
|
|
"description": [
|
|
"{@link InjectedMetadataSetup}"
|
|
],
|
|
"signature": [
|
|
"InjectedMetadataSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.theme",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "theme",
|
|
"description": [
|
|
"{@link ThemeServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"ThemeServiceSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreSetup.getStartServices",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStartServices",
|
|
"description": [
|
|
"{@link StartServicesAccessor}"
|
|
],
|
|
"signature": [
|
|
"() => Promise<[",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", TPluginsStart, TStart]>"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CoreStart",
|
|
"description": [
|
|
"\nCore services exposed to the `Plugin` start lifecycle\n"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.analytics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analytics",
|
|
"description": [
|
|
"{@link AnalyticsServiceStart}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; }"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.application",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "application",
|
|
"description": [
|
|
"{@link ApplicationStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ApplicationStart",
|
|
"text": "ApplicationStart"
|
|
}
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.chrome",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "chrome",
|
|
"description": [
|
|
"{@link ChromeStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreChromePluginApi",
|
|
"section": "def-public.ChromeStart",
|
|
"text": "ChromeStart"
|
|
}
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.docLinks",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "docLinks",
|
|
"description": [
|
|
"{@link DocLinksStart}"
|
|
],
|
|
"signature": [
|
|
"DocLinksStart"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.executionContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionContext",
|
|
"description": [
|
|
"{@link ExecutionContextStart}"
|
|
],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [
|
|
"{@link HttpStart}"
|
|
],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.savedObjects",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjects",
|
|
"description": [
|
|
"{@link SavedObjectsStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectsStart",
|
|
"text": "SavedObjectsStart"
|
|
}
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.i18n",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "i18n",
|
|
"description": [
|
|
"{@link I18nStart}"
|
|
],
|
|
"signature": [
|
|
"I18nStart"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.notifications",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "notifications",
|
|
"description": [
|
|
"{@link NotificationsStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.NotificationsStart",
|
|
"text": "NotificationsStart"
|
|
}
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.overlays",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "overlays",
|
|
"description": [
|
|
"{@link OverlayStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayStart",
|
|
"text": "OverlayStart"
|
|
}
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [
|
|
"{@link IUiSettingsClient}"
|
|
],
|
|
"signature": [
|
|
"IUiSettingsClient"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.fatalErrors",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fatalErrors",
|
|
"description": [
|
|
"{@link FatalErrorsStart}"
|
|
],
|
|
"signature": [
|
|
"FatalErrorsSetup"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.deprecations",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deprecations",
|
|
"description": [
|
|
"{@link DeprecationsServiceStart}"
|
|
],
|
|
"signature": [
|
|
"DeprecationsServiceStart"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.theme",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "theme",
|
|
"description": [
|
|
"{@link ThemeServiceStart}"
|
|
],
|
|
"signature": [
|
|
"ThemeServiceStart"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreStart.injectedMetadata",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "injectedMetadata",
|
|
"description": [
|
|
"{@link InjectedMetadataStart}"
|
|
],
|
|
"signature": [
|
|
"InjectedMetadataStart"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreTheme",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CoreTheme",
|
|
"description": [
|
|
"\nContains all the required information to apply Kibana's theme at the various levels it can be used.\n"
|
|
],
|
|
"signature": [
|
|
"CoreTheme"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-theme-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.CoreTheme.darkMode",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "darkMode",
|
|
"description": [
|
|
"is dark mode enabled or not"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-theme-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeprecationsServiceStart",
|
|
"description": [
|
|
"\nDeprecationsService provides methods to fetch domain deprecation details from\nthe Kibana server.\n"
|
|
],
|
|
"signature": [
|
|
"DeprecationsServiceStart"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart.getAllDeprecations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllDeprecations",
|
|
"description": [
|
|
"\nGrabs deprecations details for all domains."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"DomainDeprecationDetails",
|
|
"[]>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart.getDeprecations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDeprecations",
|
|
"description": [
|
|
"\nGrabs deprecations for a specific domain.\n"
|
|
],
|
|
"signature": [
|
|
"(domainId: string) => Promise<",
|
|
"DomainDeprecationDetails",
|
|
"[]>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart.getDeprecations.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "domainId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart.isDeprecationResolvable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isDeprecationResolvable",
|
|
"description": [
|
|
"\nReturns a boolean if the provided deprecation can be automatically resolvable.\n"
|
|
],
|
|
"signature": [
|
|
"(details: ",
|
|
"DomainDeprecationDetails",
|
|
") => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart.isDeprecationResolvable.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"DomainDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart.resolveDeprecation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "resolveDeprecation",
|
|
"description": [
|
|
"\nCalls the correctiveActions.api to automatically resolve the depprecation.\n"
|
|
],
|
|
"signature": [
|
|
"(details: ",
|
|
"DomainDeprecationDetails",
|
|
") => Promise<",
|
|
"ResolveDeprecationResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DeprecationsServiceStart.resolveDeprecation.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"DomainDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DocLinksStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DocLinksStart",
|
|
"description": [],
|
|
"signature": [
|
|
"DocLinksStart"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-doc-links-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DocLinksStart.DOC_LINK_VERSION",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DOC_LINK_VERSION",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-doc-links-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DocLinksStart.ELASTIC_WEBSITE_URL",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ELASTIC_WEBSITE_URL",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-doc-links-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DocLinksStart.links",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "links",
|
|
"description": [],
|
|
"signature": [
|
|
"DocLinks"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-doc-links-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EnvironmentMode",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EnvironmentMode",
|
|
"description": [],
|
|
"signature": [
|
|
"EnvironmentMode"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EnvironmentMode.name",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"production\" | \"development\""
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EnvironmentMode.dev",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "dev",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EnvironmentMode.prod",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "prod",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ErrorToastOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ErrorToastOptions",
|
|
"description": [
|
|
"\nOptions available for {@link IToasts} error APIs."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ErrorToastOptions",
|
|
"text": "ErrorToastOptions"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastOptions",
|
|
"text": "ToastOptions"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ErrorToastOptions.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [
|
|
"\nThe title of the toast and the dialog when expanding the message."
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ErrorToastOptions.toastMessage",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "toastMessage",
|
|
"description": [
|
|
"\nThe message to be shown in the toast. If this is not specified the error's\nmessage will be shown in the toast instead. Overwriting that message can\nbe used to provide more user-friendly toasts. If you specify this, the error\nmessage will still be shown in the detailed error modal."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Event",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Event",
|
|
"description": [
|
|
"\nDefinition of the full event structure"
|
|
],
|
|
"signature": [
|
|
"Event"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Event.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [
|
|
"\nThe time the event was generated in ISO format."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Event.event_type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "event_type",
|
|
"description": [
|
|
"\nThe event type."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Event.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [
|
|
"\nThe specific properties of the event type."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Event.context",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [
|
|
"\nThe {@link EventContext} enriched during the processing pipeline."
|
|
],
|
|
"signature": [
|
|
"EventContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EventContext",
|
|
"description": [
|
|
"\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}."
|
|
],
|
|
"signature": [
|
|
"EventContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.cluster_uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cluster_uuid",
|
|
"description": [
|
|
"\nThe UUID of the cluster"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.cluster_name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cluster_name",
|
|
"description": [
|
|
"\nThe name of the cluster."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.license_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "license_id",
|
|
"description": [
|
|
"\nThe license ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.userId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "userId",
|
|
"description": [
|
|
"\nThe unique user ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.cloudId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudId",
|
|
"description": [
|
|
"\nThe Cloud ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.isElasticCloudUser",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isElasticCloudUser",
|
|
"description": [
|
|
"\n`true` if the user is logged in via the Elastic Cloud authentication provider."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nThe product's version."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.pageName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pageName",
|
|
"description": [
|
|
"\nThe name of the current page."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.applicationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "applicationId",
|
|
"description": [
|
|
"\nThe current application ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.entityId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "entityId",
|
|
"description": [
|
|
"\nThe current entity ID (dashboard ID, visualization ID, etc.)."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventContext.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: unknown",
|
|
"description": [
|
|
"\nAdditional keys are allowed."
|
|
],
|
|
"signature": [
|
|
"[key: string]: unknown"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventTypeOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EventTypeOpts",
|
|
"description": [
|
|
"\nDefinition of an Event Type."
|
|
],
|
|
"signature": [
|
|
"EventTypeOpts",
|
|
"<EventTypeData>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventTypeOpts.eventType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "eventType",
|
|
"description": [
|
|
"\nThe event type's unique name."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventTypeOpts.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [
|
|
"\nSchema declaring and documenting the expected structure of this event type.\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<EventTypeData>]: ",
|
|
"SchemaValue",
|
|
"<EventTypeData[Key]>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ExecutionContextSetup",
|
|
"description": [
|
|
"\nKibana execution context.\nUsed to provide execution context to Elasticsearch, reporting, performance monitoring, etc."
|
|
],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.context$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context$",
|
|
"description": [
|
|
"\nThe current context observable"
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"KibanaExecutionContext",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [
|
|
"\nSet the current top level context"
|
|
],
|
|
"signature": [
|
|
"(c$: ",
|
|
"KibanaExecutionContext",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.set.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "c$",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaExecutionContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nGet the current top level context"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"KibanaExecutionContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.clear",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clear",
|
|
"description": [
|
|
"\nclears the context"
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.getAsLabels",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAsLabels",
|
|
"description": [
|
|
"\nreturns apm labels"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"Labels"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.withGlobalContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "withGlobalContext",
|
|
"description": [
|
|
"\nmerges the current top level context with the specific event context"
|
|
],
|
|
"signature": [
|
|
"(context?: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined) => ",
|
|
"KibanaExecutionContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextSetup.withGlobalContext.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaExecutionContext",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FatalErrorInfo",
|
|
"description": [
|
|
"\nRepresents the `message` and `stack` of a fatal Error\n"
|
|
],
|
|
"signature": [
|
|
"FatalErrorInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorInfo.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorInfo.stack",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "stack",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorsSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FatalErrorsSetup",
|
|
"description": [
|
|
"\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n"
|
|
],
|
|
"signature": [
|
|
"FatalErrorsSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorsSetup.add",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "add",
|
|
"description": [
|
|
"\nAdd a new fatal error. This will stop the Kibana Public Core and display\na fatal error screen with details about the Kibana build and the error.\n"
|
|
],
|
|
"signature": [
|
|
"(error: string | Error, source?: string | undefined) => never"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorsSetup.add.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"- The error to display"
|
|
],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorsSetup.add.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [
|
|
"- Adds a prefix of the form `${source}: ` to the error message"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorsSetup.get$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get$",
|
|
"description": [
|
|
"\nAn Observable that will emit whenever a fatal error is added with `add()`"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<",
|
|
"FatalErrorInfo",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpFetchOptions",
|
|
"description": [
|
|
"\nAll options that may be used with a {@link HttpHandler}."
|
|
],
|
|
"signature": [
|
|
"HttpFetchOptions",
|
|
" extends ",
|
|
"HttpRequestInit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptions.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [
|
|
"\nThe query string for an HTTP request. See {@link HttpFetchQuery}."
|
|
],
|
|
"signature": [
|
|
"HttpFetchQuery",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptions.prependBasePath",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "prependBasePath",
|
|
"description": [
|
|
"\nWhether or not the request should automatically prepend the basePath. Defaults to `true`."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptions.headers",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"\nHeaders to send with the request. See {@link HttpHeadersInit}."
|
|
],
|
|
"signature": [
|
|
"HttpHeadersInit",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptions.asSystemRequest",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "asSystemRequest",
|
|
"description": [
|
|
"\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptions.asResponse",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "asResponse",
|
|
"description": [
|
|
"\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptions.context",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaExecutionContext",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptionsWithPath",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpFetchOptionsWithPath",
|
|
"description": [
|
|
"\nSimilar to {@link HttpFetchOptions} but with the URL path included."
|
|
],
|
|
"signature": [
|
|
"HttpFetchOptionsWithPath",
|
|
" extends ",
|
|
"HttpFetchOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchOptionsWithPath.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchQuery",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpFetchQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpFetchQuery"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpFetchQuery.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: string | number | boolean | number[] | string[] | boolean[] | null | undefined",
|
|
"description": [
|
|
"\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array<string | number | boolean>\n | undefined\n | null;"
|
|
],
|
|
"signature": [
|
|
"[key: string]: string | number | boolean | number[] | string[] | boolean[] | null | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpHandler",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpHandler",
|
|
"description": [
|
|
"\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n"
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpHandler.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpHandler.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpHandler.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpHandler.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpHeadersInit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpHeadersInit",
|
|
"description": [
|
|
"\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error."
|
|
],
|
|
"signature": [
|
|
"HttpHeadersInit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpHeadersInit.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[name: string]: any",
|
|
"description": [],
|
|
"signature": [
|
|
"[name: string]: any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpInterceptor",
|
|
"description": [
|
|
"\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n"
|
|
],
|
|
"signature": [
|
|
"HttpInterceptor"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.request",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"\nDefine an interceptor to be executed before a request is sent."
|
|
],
|
|
"signature": [
|
|
"((fetchOptions: Readonly<",
|
|
"HttpFetchOptionsWithPath",
|
|
">, controller: ",
|
|
"IHttpInterceptController",
|
|
") => void | ",
|
|
"MaybePromise",
|
|
"<Partial<",
|
|
"HttpFetchOptionsWithPath",
|
|
">>) | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.request.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fetchOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"Readonly<",
|
|
"HttpFetchOptionsWithPath",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.request.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controller",
|
|
"description": [
|
|
"{@link IHttpInterceptController }"
|
|
],
|
|
"signature": [
|
|
"IHttpInterceptController"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.requestError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "requestError",
|
|
"description": [
|
|
"\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise."
|
|
],
|
|
"signature": [
|
|
"((httpErrorRequest: ",
|
|
"HttpInterceptorRequestError",
|
|
", controller: ",
|
|
"IHttpInterceptController",
|
|
") => void | ",
|
|
"MaybePromise",
|
|
"<Partial<",
|
|
"HttpFetchOptionsWithPath",
|
|
">>) | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.requestError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "httpErrorRequest",
|
|
"description": [
|
|
"{@link HttpInterceptorRequestError }"
|
|
],
|
|
"signature": [
|
|
"HttpInterceptorRequestError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.requestError.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controller",
|
|
"description": [
|
|
"{@link IHttpInterceptController }"
|
|
],
|
|
"signature": [
|
|
"IHttpInterceptController"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.response",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [
|
|
"\nDefine an interceptor to be executed after a response is received."
|
|
],
|
|
"signature": [
|
|
"((httpResponse: ",
|
|
"HttpResponse",
|
|
"<unknown>, controller: ",
|
|
"IHttpInterceptController",
|
|
") => void | ",
|
|
"MaybePromise",
|
|
"<",
|
|
"IHttpResponseInterceptorOverrides",
|
|
"<unknown>>) | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.response.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "httpResponse",
|
|
"description": [
|
|
"{@link HttpResponse }"
|
|
],
|
|
"signature": [
|
|
"HttpResponse",
|
|
"<unknown>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.response.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controller",
|
|
"description": [
|
|
"{@link IHttpInterceptController }"
|
|
],
|
|
"signature": [
|
|
"IHttpInterceptController"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.responseError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "responseError",
|
|
"description": [
|
|
"\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise."
|
|
],
|
|
"signature": [
|
|
"((httpErrorResponse: ",
|
|
"HttpInterceptorResponseError",
|
|
", controller: ",
|
|
"IHttpInterceptController",
|
|
") => void | ",
|
|
"MaybePromise",
|
|
"<",
|
|
"IHttpResponseInterceptorOverrides",
|
|
"<unknown>>) | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.responseError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "httpErrorResponse",
|
|
"description": [
|
|
"{@link HttpInterceptorResponseError }"
|
|
],
|
|
"signature": [
|
|
"HttpInterceptorResponseError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptor.responseError.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controller",
|
|
"description": [
|
|
"{@link IHttpInterceptController }"
|
|
],
|
|
"signature": [
|
|
"IHttpInterceptController"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptorRequestError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpInterceptorRequestError",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpInterceptorRequestError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptorRequestError.fetchOptions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fetchOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly path: string; readonly query?: ",
|
|
"HttpFetchQuery",
|
|
" | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ",
|
|
"HttpHeadersInit",
|
|
" | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptorRequestError.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptorResponseError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpInterceptorResponseError",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpInterceptorResponseError",
|
|
" extends ",
|
|
"HttpResponse",
|
|
"<unknown>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptorResponseError.request",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream<Uint8Array> | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise<ArrayBuffer>; readonly blob: () => Promise<Blob>; readonly formData: () => Promise<FormData>; readonly json: () => Promise<any>; readonly text: () => Promise<string>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpInterceptorResponseError.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | ",
|
|
"IHttpFetchError",
|
|
"<unknown>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpRequestInit",
|
|
"description": [
|
|
"\nFetch API options available to {@link HttpHandler}s.\n"
|
|
],
|
|
"signature": [
|
|
"HttpRequestInit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.body",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"\nA BodyInit object or null to set request's body."
|
|
],
|
|
"signature": [
|
|
"BodyInit | null | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.cache",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "cache",
|
|
"description": [
|
|
"\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching."
|
|
],
|
|
"signature": [
|
|
"RequestCache | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.credentials",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "credentials",
|
|
"description": [
|
|
"\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL."
|
|
],
|
|
"signature": [
|
|
"RequestCredentials | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.headers",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"{@link HttpHeadersInit}"
|
|
],
|
|
"signature": [
|
|
"HttpHeadersInit",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.integrity",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "integrity",
|
|
"description": [
|
|
"\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.keepalive",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "keepalive",
|
|
"description": [
|
|
"Whether or not request can outlive the global in which it was created."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.method",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "method",
|
|
"description": [
|
|
"HTTP method, which is \"GET\" by default."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.mode",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "mode",
|
|
"description": [
|
|
"\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs."
|
|
],
|
|
"signature": [
|
|
"RequestMode | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.redirect",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "redirect",
|
|
"description": [
|
|
"\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default."
|
|
],
|
|
"signature": [
|
|
"RequestRedirect | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.referrer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "referrer",
|
|
"description": [
|
|
"\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.referrerPolicy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "referrerPolicy",
|
|
"description": [
|
|
"\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer."
|
|
],
|
|
"signature": [
|
|
"ReferrerPolicy | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.signal",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "signal",
|
|
"description": [
|
|
"\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler."
|
|
],
|
|
"signature": [
|
|
"AbortSignal | null | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpRequestInit.window",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "window",
|
|
"description": [
|
|
"\nCan only be null. Used to disassociate request from any Window."
|
|
],
|
|
"signature": [
|
|
"null | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpResponse",
|
|
"<TResponseBody>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpResponse.fetchOptions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fetchOptions",
|
|
"description": [
|
|
"The original {@link HttpFetchOptionsWithPath} used to send this request."
|
|
],
|
|
"signature": [
|
|
"{ readonly path: string; readonly query?: ",
|
|
"HttpFetchQuery",
|
|
" | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ",
|
|
"HttpHeadersInit",
|
|
" | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpResponse.request",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"Raw request sent to Kibana server."
|
|
],
|
|
"signature": [
|
|
"{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream<Uint8Array> | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise<ArrayBuffer>; readonly blob: () => Promise<Blob>; readonly formData: () => Promise<FormData>; readonly json: () => Promise<any>; readonly text: () => Promise<string>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpResponse.response",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [
|
|
"Raw response received, may be undefined if there was an error."
|
|
],
|
|
"signature": [
|
|
"Readonly<Response> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpResponse.body",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"Parsed body received, may be undefined if there was an error."
|
|
],
|
|
"signature": [
|
|
"TResponseBody | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.basePath",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "basePath",
|
|
"description": [
|
|
"\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}"
|
|
],
|
|
"signature": [
|
|
"IBasePath"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.anonymousPaths",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "anonymousPaths",
|
|
"description": [
|
|
"\nAPIs for denoting certain paths for not requiring authentication"
|
|
],
|
|
"signature": [
|
|
"IAnonymousPaths"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.externalUrl",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "externalUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"IExternalUrl"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.intercept",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "intercept",
|
|
"description": [
|
|
"\nAdds a new {@link HttpInterceptor} to the global HTTP client."
|
|
],
|
|
"signature": [
|
|
"(interceptor: ",
|
|
"HttpInterceptor",
|
|
") => () => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.intercept.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "interceptor",
|
|
"description": [
|
|
"a {@link HttpInterceptor }"
|
|
],
|
|
"signature": [
|
|
"HttpInterceptor"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a function for removing the attached interceptor."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.fetch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fetch",
|
|
"description": [
|
|
"Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.delete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [
|
|
"Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"Makes an HTTP request with the GET method. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.head",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "head",
|
|
"description": [
|
|
"Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.options",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.patch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "patch",
|
|
"description": [
|
|
"Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.post",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "post",
|
|
"description": [
|
|
"Makes an HTTP request with the POST method. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.put",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "put",
|
|
"description": [
|
|
"Makes an HTTP request with the PUT method. See {@link HttpHandler} for options."
|
|
],
|
|
"signature": [
|
|
"HttpHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.addLoadingCountSource",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addLoadingCountSource",
|
|
"description": [
|
|
"\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0."
|
|
],
|
|
"signature": [
|
|
"(countSource$: ",
|
|
"Observable",
|
|
"<number>) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.addLoadingCountSource.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "countSource$",
|
|
"description": [
|
|
"an Observable to subscribe to for loading count updates."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<number>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpSetup.getLoadingCount$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLoadingCount$",
|
|
"description": [
|
|
"\nGet the sum of all loading count sources as a single Observable."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<number>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.I18nStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "I18nStart",
|
|
"description": [
|
|
"\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n"
|
|
],
|
|
"signature": [
|
|
"I18nStart"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.I18nStart.Context",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Context",
|
|
"description": [
|
|
"\nReact Context provider required as the topmost component for any i18n-compatible React tree."
|
|
],
|
|
"signature": [
|
|
"({ children }: { children: React.ReactNode; }) => JSX.Element"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.I18nStart.Context.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ children }",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.I18nStart.Context.$1.children",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "children",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IAnonymousPaths",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IAnonymousPaths",
|
|
"description": [
|
|
"\nAPIs for denoting paths as not requiring authentication"
|
|
],
|
|
"signature": [
|
|
"IAnonymousPaths"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IAnonymousPaths.isAnonymous",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isAnonymous",
|
|
"description": [
|
|
"\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath."
|
|
],
|
|
"signature": [
|
|
"(path: string) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IAnonymousPaths.isAnonymous.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IAnonymousPaths.register",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "register",
|
|
"description": [
|
|
"\nRegister `path` as not requiring authentication. `path` should not include the current basePath."
|
|
],
|
|
"signature": [
|
|
"(path: string) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IAnonymousPaths.register.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IBasePath",
|
|
"description": [
|
|
"\nAPIs for manipulating the basePath on URL segments."
|
|
],
|
|
"signature": [
|
|
"IBasePath"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nGets the `basePath` string."
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath.prepend",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "prepend",
|
|
"description": [
|
|
"\nPrepends `path` with the basePath."
|
|
],
|
|
"signature": [
|
|
"(url: string) => string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath.prepend.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "url",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath.remove",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "remove",
|
|
"description": [
|
|
"\nRemoves the prepended basePath from the `path`."
|
|
],
|
|
"signature": [
|
|
"(url: string) => string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath.remove.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "url",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath.serverBasePath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "serverBasePath",
|
|
"description": [
|
|
"\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IBasePath.publicBaseUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "publicBaseUrl",
|
|
"description": [
|
|
"\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IExternalUrl",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExternalUrl",
|
|
"description": [
|
|
"\nAPIs for working with external URLs.\n"
|
|
],
|
|
"signature": [
|
|
"IExternalUrl"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IExternalUrl.isInternalUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isInternalUrl",
|
|
"description": [
|
|
"\nDetermines if the provided URL is an internal url.\n"
|
|
],
|
|
"signature": [
|
|
"(relativeOrAbsoluteUrl: string) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IExternalUrl.isInternalUrl.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "relativeOrAbsoluteUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IExternalUrl.validateUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateUrl",
|
|
"description": [
|
|
"\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n"
|
|
],
|
|
"signature": [
|
|
"(relativeOrAbsoluteUrl: string) => URL | null"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IExternalUrl.validateUrl.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "relativeOrAbsoluteUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpFetchError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IHttpFetchError",
|
|
"description": [],
|
|
"signature": [
|
|
"IHttpFetchError",
|
|
"<TResponseBody> extends Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpFetchError.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpFetchError.request",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"Request"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpFetchError.response",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"Response | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpFetchError.req",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "req",
|
|
"description": [],
|
|
"signature": [
|
|
"Request"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": true,
|
|
"removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.",
|
|
"references": [
|
|
{
|
|
"plugin": "ml",
|
|
"path": "x-pack/plugins/ml/common/util/errors/errors.test.ts"
|
|
},
|
|
{
|
|
"plugin": "ml",
|
|
"path": "x-pack/plugins/ml/common/util/errors/errors.test.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-http-browser-internal",
|
|
"path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-http-browser-internal",
|
|
"path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpFetchError.res",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "res",
|
|
"description": [],
|
|
"signature": [
|
|
"Response | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": true,
|
|
"removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.",
|
|
"references": [
|
|
{
|
|
"plugin": "@kbn/core-http-browser-internal",
|
|
"path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-http-browser-internal",
|
|
"path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpFetchError.body",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"TResponseBody | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpInterceptController",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IHttpInterceptController",
|
|
"description": [
|
|
"\nUsed to halt a request Promise chain in a {@link HttpInterceptor}."
|
|
],
|
|
"signature": [
|
|
"IHttpInterceptController"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpInterceptController.halted",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "halted",
|
|
"description": [
|
|
"Whether or not this chain has been halted."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpInterceptController.halt",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "halt",
|
|
"description": [
|
|
"Halt the request Promise chain and do not process further interceptors or response handlers."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpResponseInterceptorOverrides",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IHttpResponseInterceptorOverrides",
|
|
"description": [
|
|
"\nProperties that can be returned by HttpInterceptor.request to override the response."
|
|
],
|
|
"signature": [
|
|
"IHttpResponseInterceptorOverrides",
|
|
"<TResponseBody>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpResponseInterceptorOverrides.response",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [
|
|
"Raw response received, may be undefined if there was an error."
|
|
],
|
|
"signature": [
|
|
"Readonly<Response> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IHttpResponseInterceptorOverrides.body",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"Parsed body received, may be undefined if there was an error."
|
|
],
|
|
"signature": [
|
|
"TResponseBody | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IShipper",
|
|
"description": [
|
|
"\nBasic structure of a Shipper"
|
|
],
|
|
"signature": [
|
|
"IShipper"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.reportEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportEvents",
|
|
"description": [
|
|
"\nAdapts and ships the event to the persisting/analytics solution."
|
|
],
|
|
"signature": [
|
|
"(events: ",
|
|
"Event",
|
|
"[]) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.reportEvents.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "events",
|
|
"description": [
|
|
"batched events {@link Event }"
|
|
],
|
|
"signature": [
|
|
"Event",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.optIn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "optIn",
|
|
"description": [
|
|
"\nStops/restarts the shipping mechanism based on the value of isOptedIn"
|
|
],
|
|
"signature": [
|
|
"(isOptedIn: boolean) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.optIn.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isOptedIn",
|
|
"description": [
|
|
"`true` for resume sending events. `false` to stop."
|
|
],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.extendContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "extendContext",
|
|
"description": [
|
|
"\nPerform any necessary calls to the persisting/analytics solution to set the event's context."
|
|
],
|
|
"signature": [
|
|
"((newContext: ",
|
|
"EventContext",
|
|
") => void) | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.extendContext.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newContext",
|
|
"description": [
|
|
"The full new context to set {@link EventContext }"
|
|
],
|
|
"signature": [
|
|
"EventContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.telemetryCounter$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryCounter$",
|
|
"description": [
|
|
"\nObservable to emit the stats of the processed events."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
"> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IShipper.shutdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shutdown",
|
|
"description": [
|
|
"\nShutdown the shipper."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IUiSettingsClient",
|
|
"description": [
|
|
"\nClient-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n{@link IUiSettingsClient}\n"
|
|
],
|
|
"signature": [
|
|
"IUiSettingsClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nGets the value for a specific uiSetting. If this setting has no user-defined value\nthen the `defaultOverride` parameter is returned (and parsed if setting is of type\n\"json\" or \"number). If the parameter is not defined and the key is not registered\nby any plugin then an error is thrown, otherwise reads the default value defined by a plugin."
|
|
],
|
|
"signature": [
|
|
"<T = any>(key: string, defaultOverride?: T | undefined) => T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.get.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultOverride",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.get$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get$",
|
|
"description": [
|
|
"\nGets an observable of the current value for a config key, and all updates to that config\nkey in the future. Providing a `defaultOverride` argument behaves the same as it does in #get()"
|
|
],
|
|
"signature": [
|
|
"<T = any>(key: string, defaultOverride?: T | undefined) => ",
|
|
"Observable",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.get$.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.get$.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultOverride",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.getAll",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAll",
|
|
"description": [
|
|
"\nGets the metadata about all uiSettings, including the type, default value, and user value\nfor each key."
|
|
],
|
|
"signature": [
|
|
"() => Readonly<Record<string, ",
|
|
"PublicUiSettingsParams",
|
|
" & ",
|
|
"UserProvidedValues",
|
|
"<any>>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [
|
|
"\nSets the value for a uiSetting. If the setting is not registered by any plugin\nit will be stored as a custom setting. The new value will be synchronously available via\nthe `get()` method and sent to the server in the background. If the request to the\nserver fails then a updateErrors$ will be notified and the setting will be\nreverted to its value before `set()` was called."
|
|
],
|
|
"signature": [
|
|
"(key: string, value: any) => Promise<boolean>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.set.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.set.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.remove",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "remove",
|
|
"description": [
|
|
"\nRemoves the user-defined value for a setting, causing it to revert to the default. This\nmethod behaves the same as calling `set(key, null)`, including the synchronization, custom\nsetting, and error behavior of that method."
|
|
],
|
|
"signature": [
|
|
"(key: string) => Promise<boolean>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.remove.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isDeclared",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isDeclared",
|
|
"description": [
|
|
"\nReturns true if the key is a \"known\" uiSetting, meaning it is either registered\nby any plugin or was previously added as a custom setting via the `set()` method."
|
|
],
|
|
"signature": [
|
|
"(key: string) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isDeclared.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isDefault",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isDefault",
|
|
"description": [
|
|
"\nReturns true if the setting has no user-defined value or is unknown"
|
|
],
|
|
"signature": [
|
|
"(key: string) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isDefault.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isCustom",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCustom",
|
|
"description": [
|
|
"\nReturns true if the setting wasn't registered by any plugin, but was either\nadded directly via `set()`, or is an unknown setting found in the uiSettings saved\nobject"
|
|
],
|
|
"signature": [
|
|
"(key: string) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isCustom.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isOverridden",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isOverridden",
|
|
"description": [
|
|
"\nShows whether the uiSettings value set by the user."
|
|
],
|
|
"signature": [
|
|
"(key: string) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.isOverridden.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.getUpdate$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdate$",
|
|
"description": [
|
|
"\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed."
|
|
],
|
|
"signature": [
|
|
"<T = any>() => ",
|
|
"Observable",
|
|
"<{ key: string; newValue: T; oldValue: T; }>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IUiSettingsClient.getUpdateErrors$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdateErrors$",
|
|
"description": [
|
|
"\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<Error>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.NotificationsSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NotificationsSetup",
|
|
"description": [],
|
|
"path": "src/core/public/notifications/notifications_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.NotificationsSetup.toasts",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [
|
|
"{@link ToastsSetup}"
|
|
],
|
|
"signature": [
|
|
"{ 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"
|
|
},
|
|
"; get$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/core/public/notifications/notifications_service.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.NotificationsStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NotificationsStart",
|
|
"description": [],
|
|
"path": "src/core/public/notifications/notifications_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.NotificationsStart.toasts",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [
|
|
"{@link ToastsStart}"
|
|
],
|
|
"signature": [
|
|
"{ 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"
|
|
},
|
|
"; get$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/core/public/notifications/notifications_service.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OptInConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OptInConfig",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"OptInConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OptInConfig.global",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "global",
|
|
"description": [
|
|
"\nControls the global enabled/disabled behaviour of the client and shippers."
|
|
],
|
|
"signature": [
|
|
"OptInConfigPerType"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OptInConfig.event_types",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "event_types",
|
|
"description": [
|
|
"\nControls if an event type should be disabled for a specific type of shipper."
|
|
],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"OptInConfigPerType",
|
|
" | undefined> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayBannersStart",
|
|
"description": [],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.add",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "add",
|
|
"description": [
|
|
"\nAdd a new banner\n"
|
|
],
|
|
"signature": [
|
|
"(mount: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, priority?: number | undefined) => string"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.add.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mount",
|
|
"description": [
|
|
"{@link MountPoint }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.add.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "priority",
|
|
"description": [
|
|
"optional priority order to display this banner. Higher priority values are shown first."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a unique identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.remove",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "remove",
|
|
"description": [
|
|
"\nRemove a banner\n"
|
|
],
|
|
"signature": [
|
|
"(id: string) => boolean"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.remove.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"the unique identifier for the banner returned by {@link OverlayBannersStart.add }"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"if the banner was found or not"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.replace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "replace",
|
|
"description": [
|
|
"\nReplace a banner in place\n"
|
|
],
|
|
"signature": [
|
|
"(id: string | undefined, mount: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, priority?: number | undefined) => string"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.replace.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"the unique identifier for the banner returned by {@link OverlayBannersStart.add }"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.replace.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mount",
|
|
"description": [
|
|
"{@link MountPoint }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.replace.$3",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "priority",
|
|
"description": [
|
|
"optional priority order to display this banner. Higher priority values are shown first."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"a new identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayBannersStart.getComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"path": "src/core/public/overlays/banners/banners_service.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayFlyoutOpenOptions",
|
|
"description": [],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.className",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "className",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "closeButtonAriaLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.ownFocus",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ownFocus",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.datatestsubj",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "'data-test-subj'",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.arialabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "'aria-label'",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.size",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"\"s\" | \"m\" | \"l\" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.maxWidth",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "maxWidth",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | boolean | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.hideCloseButton",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hideCloseButton",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.outsideClickCloses",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "outsideClickCloses",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.maskProps",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "maskProps",
|
|
"description": [],
|
|
"signature": [
|
|
"EuiOverlayMaskProps",
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.onClose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onClose",
|
|
"description": [
|
|
"\nEuiFlyout onClose handler.\nIf provided the consumer is responsible for calling flyout.close() to close the flyout;"
|
|
],
|
|
"signature": [
|
|
"((flyout: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
},
|
|
") => void) | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutOpenOptions.onClose.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "flyout",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayFlyoutStart",
|
|
"description": [
|
|
"\nAPIs to open and manage fly-out dialogs.\n"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutStart.open",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "open",
|
|
"description": [
|
|
"\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n"
|
|
],
|
|
"signature": [
|
|
"(mount: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayFlyoutOpenOptions",
|
|
"text": "OverlayFlyoutOpenOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutStart.open.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mount",
|
|
"description": [
|
|
"{@link MountPoint } - Mounts the children inside a flyout panel"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayFlyoutStart.open.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"{@link OverlayFlyoutOpenOptions } - options for the flyout"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayFlyoutOpenOptions",
|
|
"text": "OverlayFlyoutOpenOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayModalConfirmOptions",
|
|
"description": [],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.cancelButtonText",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cancelButtonText",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.confirmButtonText",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "confirmButtonText",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.className",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "className",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.closeButtonAriaLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "closeButtonAriaLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.datatestsubj",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "'data-test-subj'",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.defaultFocusedButton",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "defaultFocusedButton",
|
|
"description": [],
|
|
"signature": [
|
|
"\"cancel\" | \"confirm\" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.buttonColor",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "buttonColor",
|
|
"description": [],
|
|
"signature": [
|
|
"ButtonColor",
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalConfirmOptions.maxWidth",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "maxWidth",
|
|
"description": [
|
|
"\nSets the max-width of the modal.\nSet to `true` to use the default (`euiBreakpoints 'm'`),\nset to `false` to not restrict the width,\nset to a number for a custom width in px,\nset to a string for a custom width in custom measurement."
|
|
],
|
|
"signature": [
|
|
"string | number | boolean | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalOpenOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayModalOpenOptions",
|
|
"description": [],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalOpenOptions.className",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "className",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalOpenOptions.closeButtonAriaLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "closeButtonAriaLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalOpenOptions.datatestsubj",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "'data-test-subj'",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalOpenOptions.maxWidth",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "maxWidth",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | boolean | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayModalStart",
|
|
"description": [
|
|
"\nAPIs to open and manage modal dialogs.\n"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalStart.open",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "open",
|
|
"description": [
|
|
"\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n"
|
|
],
|
|
"signature": [
|
|
"(mount: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalOpenOptions",
|
|
"text": "OverlayModalOpenOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalStart.open.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mount",
|
|
"description": [
|
|
"{@link MountPoint } - Mounts the children inside the modal"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalStart.open.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"{@link OverlayModalOpenOptions } - options for the modal"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalOpenOptions",
|
|
"text": "OverlayModalOpenOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalStart.openConfirm",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openConfirm",
|
|
"description": [
|
|
"\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n"
|
|
],
|
|
"signature": [
|
|
"(message: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalConfirmOptions",
|
|
"text": "OverlayModalConfirmOptions"
|
|
},
|
|
" | undefined) => Promise<boolean>"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalStart.openConfirm.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"{@link MountPoint } - string or mountpoint to be used a the confirm message body"
|
|
],
|
|
"signature": [
|
|
"string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayModalStart.openConfirm.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"{@link OverlayModalConfirmOptions } - options for the confirm modal"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalConfirmOptions",
|
|
"text": "OverlayModalConfirmOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayRef",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayRef",
|
|
"description": [
|
|
"\nReturned by {@link OverlayStart} methods for closing a mounted overlay."
|
|
],
|
|
"path": "src/core/public/overlays/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayRef.onClose",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "onClose",
|
|
"description": [
|
|
"\nA Promise that will resolve once this overlay is closed.\n\nOverlays can close from user interaction, calling `close()` on the overlay\nreference or another overlay replacing yours via `openModal` or `openFlyout`."
|
|
],
|
|
"signature": [
|
|
"Promise<void>"
|
|
],
|
|
"path": "src/core/public/overlays/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayRef.close",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "close",
|
|
"description": [
|
|
"\nCloses the referenced overlay if it's still open which in turn will\nresolve the `onClose` Promise. If the overlay had already been\nclosed this method does nothing."
|
|
],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "src/core/public/overlays/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OverlayStart",
|
|
"description": [],
|
|
"path": "src/core/public/overlays/overlay_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.banners",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "banners",
|
|
"description": [
|
|
"{@link OverlayBannersStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayBannersStart",
|
|
"text": "OverlayBannersStart"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/overlay_service.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openFlyout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openFlyout",
|
|
"description": [
|
|
"{@link OverlayFlyoutStart#open}"
|
|
],
|
|
"signature": [
|
|
"(mount: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayFlyoutOpenOptions",
|
|
"text": "OverlayFlyoutOpenOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/overlay_service.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openFlyout.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mount",
|
|
"description": [],
|
|
"signature": [
|
|
"(element: HTMLElement) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.UnmountCallback",
|
|
"text": "UnmountCallback"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openFlyout.$1.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "element",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/core/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openFlyout.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayFlyoutOpenOptions",
|
|
"text": "OverlayFlyoutOpenOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/flyout/flyout_service.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openModal",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openModal",
|
|
"description": [
|
|
"{@link OverlayModalStart#open}"
|
|
],
|
|
"signature": [
|
|
"(mount: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalOpenOptions",
|
|
"text": "OverlayModalOpenOptions"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/overlay_service.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openModal.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mount",
|
|
"description": [],
|
|
"signature": [
|
|
"(element: HTMLElement) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.UnmountCallback",
|
|
"text": "UnmountCallback"
|
|
}
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openModal.$1.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "element",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/core/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openModal.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalOpenOptions",
|
|
"text": "OverlayModalOpenOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openConfirm",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openConfirm",
|
|
"description": [
|
|
"{@link OverlayModalStart#openConfirm}"
|
|
],
|
|
"signature": [
|
|
"(message: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalConfirmOptions",
|
|
"text": "OverlayModalConfirmOptions"
|
|
},
|
|
" | undefined) => Promise<boolean>"
|
|
],
|
|
"path": "src/core/public/overlays/overlay_service.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openConfirm.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"signature": [
|
|
"string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement>"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.OverlayStart.openConfirm.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayModalConfirmOptions",
|
|
"text": "OverlayModalConfirmOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/public/overlays/modal/modal_service.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PackageInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"PackageInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PackageInfo.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PackageInfo.branch",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "branch",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PackageInfo.buildNum",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "buildNum",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PackageInfo.buildSha",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buildSha",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PackageInfo.dist",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "dist",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Plugin",
|
|
"description": [
|
|
"\nThe interface that should be returned by a `PluginInitializer`.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<TSetup, TStart, TPluginsSetup, TPluginsStart>"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<TPluginsStart, TStart>, plugins: TPluginsSetup) => TSetup"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<TPluginsStart, TStart>"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin.setup.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
"TPluginsSetup"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", plugins: TPluginsStart) => TStart"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin.start.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
"TPluginsStart"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Plugin.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PluginInitializerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginInitializerContext",
|
|
"description": [
|
|
"\nThe available core services passed to a `PluginInitializer`\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<ConfigSchema>"
|
|
],
|
|
"path": "src/core/public/plugins/plugin_context.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PluginInitializerContext.opaqueId",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "opaqueId",
|
|
"description": [
|
|
"\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers."
|
|
],
|
|
"signature": [
|
|
"symbol"
|
|
],
|
|
"path": "src/core/public/plugins/plugin_context.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PluginInitializerContext.env",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "env",
|
|
"description": [],
|
|
"signature": [
|
|
"{ mode: Readonly<",
|
|
"EnvironmentMode",
|
|
">; packageInfo: Readonly<",
|
|
"PackageInfo",
|
|
">; }"
|
|
],
|
|
"path": "src/core/public/plugins/plugin_context.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PluginInitializerContext.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
"{ get: <T extends object = ConfigSchema>() => T; }"
|
|
],
|
|
"path": "src/core/public/plugins/plugin_context.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResolvedSimpleSavedObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ResolvedSimpleSavedObject",
|
|
"description": [
|
|
"\nThis interface is a very simple wrapper for SavedObjects resolved from the server\nwith the {@link SavedObjectsClientContract}.\n"
|
|
],
|
|
"signature": [
|
|
"ResolvedSimpleSavedObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResolvedSimpleSavedObject.saved_object",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "saved_object",
|
|
"description": [
|
|
"\nThe saved object that was found."
|
|
],
|
|
"signature": [
|
|
"SimpleSavedObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResolvedSimpleSavedObject.outcome",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "outcome",
|
|
"description": [
|
|
"\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID."
|
|
],
|
|
"signature": [
|
|
"\"exactMatch\" | \"aliasMatch\" | \"conflict\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResolvedSimpleSavedObject.alias_target_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "alias_target_id",
|
|
"description": [
|
|
"\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResolvedSimpleSavedObject.alias_purpose",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "alias_purpose",
|
|
"description": [
|
|
"\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)."
|
|
],
|
|
"signature": [
|
|
"\"savedObjectConversion\" | \"savedObjectImport\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResponseErrorBody",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ResponseErrorBody",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseErrorBody"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResponseErrorBody.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResponseErrorBody.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResponseErrorBody.attributes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObject",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
" The type of Saved Object. Each plugin can define it's own custom Saved Object types."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.updated_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_at",
|
|
"description": [
|
|
"Timestamp of the last time this document had been updated."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectError",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.attributes",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectAttributes}"
|
|
],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectReference}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.migrationVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "migrationVersion",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectsMigrationVersion}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.coreMigrationVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "coreMigrationVersion",
|
|
"description": [
|
|
"A semver value that is used when upgrading objects between Kibana versions."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObject.originId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "originId",
|
|
"description": [
|
|
"\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectAttributes",
|
|
"description": [
|
|
"\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectAttributes"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectAttributes.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: SavedObjectAttribute",
|
|
"description": [],
|
|
"signature": [
|
|
"[key: string]: ",
|
|
"SavedObjectAttribute"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectError",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectError.error",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectError.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectError.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectError.metadata",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metadata",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, unknown> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectReference",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectReference",
|
|
"description": [
|
|
"\nA reference to another saved object.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectReference"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectReference.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectReference.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectReference.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBatchResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBatchResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBatchResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBatchResponse.savedObjects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "savedObjects",
|
|
"description": [],
|
|
"signature": [
|
|
"SimpleSavedObject",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkCreateObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkCreateObject",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkCreateObject",
|
|
"<T> extends ",
|
|
"SavedObjectsCreateOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkCreateObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkCreateObject.attributes",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkCreateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkCreateOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkCreateOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkCreateOptions.overwrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [
|
|
"If a document with the given `id` already exists, overwrite it's contents (default=false)."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkResolveResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkResolveResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkResolveResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkResolveResponse.resolved_objects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "resolved_objects",
|
|
"description": [],
|
|
"signature": [
|
|
"ResolvedSimpleSavedObject",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkUpdateObject",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateObject.attributes",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateObject.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateObject.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkUpdateOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsBulkUpdateOptions.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsClientContract",
|
|
"description": [
|
|
"\nThe client-side SavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsClientContract"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.create",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [
|
|
"\nPersists an object"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, attributes: T, options?: ",
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined) => Promise<",
|
|
"SimpleSavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.create.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.create.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.create.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkCreate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkCreate",
|
|
"description": [
|
|
"\nCreates multiple documents at once"
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectsBulkCreateObject",
|
|
"<unknown>[], options?: ",
|
|
"SavedObjectsBulkCreateOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBatchResponse",
|
|
"<unknown>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkCreate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkCreateObject",
|
|
"<unknown>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkCreate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkCreateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The result of the create operation containing created saved objects."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.delete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [
|
|
"\nDeletes an object"
|
|
],
|
|
"signature": [
|
|
"(type: string, id: string, options?: ",
|
|
"SavedObjectsDeleteOptions",
|
|
" | undefined) => Promise<{}>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.delete.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.delete.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.delete.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsDeleteOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.find",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property"
|
|
],
|
|
"label": "find",
|
|
"description": [
|
|
"\nSearch for objects\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown, A = unknown>(options: ",
|
|
"SavedObjectsFindOptions",
|
|
") => Promise<",
|
|
"SavedObjectsFindResponse",
|
|
"<T, unknown>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.find.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsFindOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"A find result with objects matching the specified search."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nFetches a single object\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string) => Promise<",
|
|
"SimpleSavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.get.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The saved object for the given type and id."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkGet",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkGet",
|
|
"description": [
|
|
"\nReturns an array of objects by id\n"
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectTypeIdTuple",
|
|
"[]) => Promise<",
|
|
"SavedObjectsBatchResponse",
|
|
"<unknown>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkGet.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- an array ids, or an array of objects containing id and optionally type"
|
|
],
|
|
"signature": [
|
|
"SavedObjectTypeIdTuple",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The saved objects with the given type and ids requested"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.resolve",
|
|
"type": "Function",
|
|
"tags": [
|
|
"note"
|
|
],
|
|
"label": "resolve",
|
|
"description": [
|
|
"\nResolves a single object\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string) => Promise<",
|
|
"ResolvedSimpleSavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.resolve.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.resolve.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The resolve result for the saved object for the given type and id."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkResolve",
|
|
"type": "Function",
|
|
"tags": [
|
|
"note"
|
|
],
|
|
"label": "bulkResolve",
|
|
"description": [
|
|
"\nResolves an array of objects by id, using any legacy URL aliases if they exist\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectTypeIdTuple",
|
|
"[]) => Promise<",
|
|
"SavedObjectsBulkResolveResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkResolve.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- an array of objects containing id, type"
|
|
],
|
|
"signature": [
|
|
"SavedObjectTypeIdTuple",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The bulk resolve result for the saved objects for the given types and ids."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.update",
|
|
"type": "Function",
|
|
"tags": [
|
|
"prop",
|
|
"prop"
|
|
],
|
|
"label": "update",
|
|
"description": [
|
|
"\nUpdates an object\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, attributes: T, options?: ",
|
|
"SavedObjectsUpdateOptions",
|
|
"<unknown> | undefined) => Promise<",
|
|
"SimpleSavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.update.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.update.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.update.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.update.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateOptions",
|
|
"<unknown> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkUpdate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkUpdate",
|
|
"description": [
|
|
"\nUpdate multiple documents at once\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<unknown>[]) => Promise<",
|
|
"SavedObjectsBatchResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsClientContract.bulkUpdate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- [{ type, id, attributes, options: { version, references } }]"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<unknown>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The result of the update operation containing both failed and updated saved objects."
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsCreateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCreateOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreateOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsCreateOptions.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\n(Not recommended) Specify an id instead of having the saved objects service generate one for you."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsCreateOptions.overwrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [
|
|
"If a document with the given `id` already exists, overwrite it's contents (default=false)."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsCreateOptions.migrationVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "migrationVersion",
|
|
"description": [
|
|
"{@inheritDoc SavedObjectsMigrationVersion}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "coreMigrationVersion",
|
|
"description": [
|
|
"A semver value that is used when upgrading objects between Kibana versions."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsCreateOptions.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsDeleteOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsDeleteOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsDeleteOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsDeleteOptions.force",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "force",
|
|
"description": [
|
|
"Force deletion of an object that exists in multiple namespaces"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindOptionsReference",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsFindOptionsReference",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsFindOptionsReference"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindOptionsReference.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindOptionsReference.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsFindResponse",
|
|
"description": [
|
|
"\nReturn type of the Saved Objects `find()` method.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsFindResponse",
|
|
"<T, A> extends ",
|
|
"SavedObjectsBatchResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindResponse.aggregations",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggregations",
|
|
"description": [],
|
|
"signature": [
|
|
"A | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindResponse.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindResponse.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindResponse.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportActionRequiredWarning",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportActionRequiredWarning",
|
|
"description": [
|
|
"\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportActionRequiredWarning"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportActionRequiredWarning.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"action_required\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportActionRequiredWarning.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"The translated message to display to the user."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportActionRequiredWarning.actionPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionPath",
|
|
"description": [
|
|
"The path (without the basePath) that the user should be redirect to address this warning."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportActionRequiredWarning.buttonLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buttonLabel",
|
|
"description": [
|
|
"An optional label to use for the link button. If unspecified, a default label will be used."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportAmbiguousConflictError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportAmbiguousConflictError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportAmbiguousConflictError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportAmbiguousConflictError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ambiguous_conflict\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportAmbiguousConflictError.destinations",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "destinations",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportConflictError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportConflictError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to a conflict."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportConflictError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportConflictError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"conflict\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportConflictError.destinationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "destinationId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportFailure",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportFailure",
|
|
"description": [
|
|
"\nRepresents a failure to import."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportFailure"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportFailure.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportFailure.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportFailure.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title?: string | undefined; icon?: string | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportFailure.overwrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [
|
|
"\nIf `overwrite` is specified, an attempt was made to overwrite an existing object."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportFailure.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportConflictError",
|
|
" | ",
|
|
"SavedObjectsImportAmbiguousConflictError",
|
|
" | ",
|
|
"SavedObjectsImportUnsupportedTypeError",
|
|
" | ",
|
|
"SavedObjectsImportMissingReferencesError",
|
|
" | ",
|
|
"SavedObjectsImportUnknownError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportMissingReferencesError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportMissingReferencesError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to missing references."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportMissingReferencesError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportMissingReferencesError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"missing_references\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportMissingReferencesError.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; id: string; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportResponse",
|
|
"description": [
|
|
"\nThe response describing the result of an import."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportResponse"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportResponse.success",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "success",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportResponse.successCount",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "successCount",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportResponse.successResults",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "successResults",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportSuccess",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportResponse.warnings",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "warnings",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportWarning",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportResponse.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportFailure",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportRetry",
|
|
"description": [
|
|
"\nDescribes a retry operation for importing a saved object."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportRetry"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry.overwrite",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry.destinationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "destinationId",
|
|
"description": [
|
|
"\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry.replaceReferences",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "replaceReferences",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; from: string; to: string; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry.createNewCopy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "createNewCopy",
|
|
"description": [
|
|
"\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportRetry.ignoreMissingReferences",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ignoreMissingReferences",
|
|
"description": [
|
|
"\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSimpleWarning",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportSimpleWarning",
|
|
"description": [
|
|
"\nA simple informative warning that will be displayed to the user.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportSimpleWarning"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSimpleWarning.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"simple\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSimpleWarning.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"The translated message to display to the user"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSuccess",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportSuccess",
|
|
"description": [
|
|
"\nRepresents a successful import."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportSuccess"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSuccess.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSuccess.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSuccess.destinationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "destinationId",
|
|
"description": [
|
|
"\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSuccess.createNewCopy",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "createNewCopy",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "spaces",
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx"
|
|
},
|
|
{
|
|
"plugin": "savedObjectsManagement",
|
|
"path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSuccess.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title?: string | undefined; icon?: string | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportSuccess.overwrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [
|
|
"\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportUnknownError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportUnknownError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to an unknown reason."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportUnknownError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportUnknownError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"unknown\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportUnknownError.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportUnknownError.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportUnsupportedTypeError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportUnsupportedTypeError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to having an unsupported saved object type."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportUnsupportedTypeError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportUnsupportedTypeError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"unsupported_type\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsMigrationVersion",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsMigrationVersion",
|
|
"description": [
|
|
"\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsMigrationVersion.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[pluginName: string]: string",
|
|
"description": [],
|
|
"signature": [
|
|
"[pluginName: string]: string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsUpdateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsUpdateOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateOptions",
|
|
"<Attributes>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsUpdateOptions.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsUpdateOptions.upsert",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "upsert",
|
|
"description": [],
|
|
"signature": [
|
|
"Attributes | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsUpdateOptions.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectTypeIdTuple",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectTypeIdTuple",
|
|
"description": [
|
|
"\nAn identifier for a saved object within a space.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectTypeIdTuple"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectTypeIdTuple.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"The id of the saved object"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectTypeIdTuple.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"The type of the saved object"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ShipperClassConstructor",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShipperClassConstructor",
|
|
"description": [
|
|
"\nConstructor of a {@link IShipper}"
|
|
],
|
|
"signature": [
|
|
"ShipperClassConstructor",
|
|
"<Shipper, Config>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ShipperClassConstructor.shipperName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "shipperName",
|
|
"description": [
|
|
"\nThe shipper's unique name"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ShipperClassConstructor.new",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "new",
|
|
"description": [
|
|
"\nThe constructor"
|
|
],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ShipperClassConstructor.new.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [
|
|
"The shipper's custom config"
|
|
],
|
|
"signature": [
|
|
"Config"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ShipperClassConstructor.new.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [
|
|
"Common context {@link AnalyticsClientInitContext }"
|
|
],
|
|
"signature": [
|
|
"AnalyticsClientInitContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SimpleSavedObject",
|
|
"description": [
|
|
"\nVery simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClientContract}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n"
|
|
],
|
|
"signature": [
|
|
"SimpleSavedObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.attributes",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject._version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "_version",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.migrationVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "migrationVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.coreMigrationVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "coreMigrationVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectError",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.updatedAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updatedAt",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string) => any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string, value: any) => T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.set.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.set.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.has",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "has",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: string) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.has.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.save",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "save",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"SimpleSavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SimpleSavedObject.delete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<{}>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.TelemetryCounter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TelemetryCounter",
|
|
"description": [
|
|
"\nShape of the events emitted by the telemetryCounter$ observable"
|
|
],
|
|
"signature": [
|
|
"TelemetryCounter"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.TelemetryCounter.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\n{@link TelemetryCounterType}"
|
|
],
|
|
"signature": [
|
|
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.TelemetryCounter.source",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [
|
|
"\nWho emitted the event? It can be \"client\" or the name of the shipper."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.TelemetryCounter.event_type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "event_type",
|
|
"description": [
|
|
"\nThe event type the success/failure/drop event refers to."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.TelemetryCounter.code",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "code",
|
|
"description": [
|
|
"\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.TelemetryCounter.count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [
|
|
"\nThe number of events that this counter refers to."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ThemeServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ThemeServiceSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"ThemeServiceSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-theme-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ThemeServiceSetup.theme$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "theme$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"CoreTheme",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-theme-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ThemeServiceStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ThemeServiceStart",
|
|
"description": [],
|
|
"signature": [
|
|
"ThemeServiceStart"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-theme-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ThemeServiceStart.theme$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "theme$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"CoreTheme",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-theme-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ToastOptions",
|
|
"description": [
|
|
"\nOptions available for {@link IToasts} APIs."
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastOptions.toastLifeTimeMs",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "toastLifeTimeMs",
|
|
"description": [
|
|
"\nHow long should the toast remain on screen."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UiSettingsParams",
|
|
"description": [
|
|
"\nUiSettings parameters defined by the plugins."
|
|
],
|
|
"signature": [
|
|
"UiSettingsParams",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"title in the UI"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.value",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [
|
|
"default value to fall back to if a user doesn't provide any"
|
|
],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"description provided to a user in UI"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.category",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [
|
|
"used to group the configured setting in the UI"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.options",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"array of permitted values for this setting"
|
|
],
|
|
"signature": [
|
|
"number[] | string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.optionLabels",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "optionLabels",
|
|
"description": [
|
|
"text labels for 'select' type UI element"
|
|
],
|
|
"signature": [
|
|
"Record<string, string> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.requiresPageReload",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requiresPageReload",
|
|
"description": [
|
|
"a flag indicating whether new value applying requires page reloading"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.readonly",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "readonly",
|
|
"description": [
|
|
"a flag indicating that value cannot be changed"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.sensitive",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sensitive",
|
|
"description": [
|
|
"\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"defines a type of UI element {@link UiSettingsType}"
|
|
],
|
|
"signature": [
|
|
"UiSettingsType",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.deprecation",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deprecation",
|
|
"description": [
|
|
"optional deprecation information. Used to generate a deprecation warning."
|
|
],
|
|
"signature": [
|
|
"DeprecationSettings",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [
|
|
"\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [],
|
|
"signature": [
|
|
"Type",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsParams.metric",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "metric",
|
|
"description": [
|
|
"\nMetric to track once this property changes"
|
|
],
|
|
"signature": [
|
|
"{ type: string; name: string; } | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "advancedSettings",
|
|
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts"
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"path": "src/plugins/discover/server/ui_settings.ts"
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"path": "src/plugins/discover/server/ui_settings.ts"
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"path": "src/plugins/discover/server/ui_settings.ts"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UiSettingsState",
|
|
"description": [],
|
|
"signature": [
|
|
"UiSettingsState"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsState.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: PublicUiSettingsParams & UserProvidedValues<any>",
|
|
"description": [],
|
|
"signature": [
|
|
"[key: string]: ",
|
|
"PublicUiSettingsParams",
|
|
" & ",
|
|
"UserProvidedValues",
|
|
"<any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UserProvidedValues",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserProvidedValues",
|
|
"description": [
|
|
"\nDescribes the values explicitly set by user."
|
|
],
|
|
"signature": [
|
|
"UserProvidedValues",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UserProvidedValues.userValue",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "userValue",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UserProvidedValues.isOverridden",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isOverridden",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsServiceSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AnalyticsServiceSetup",
|
|
"description": [
|
|
"\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.AnalyticsServiceStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AnalyticsServiceStart",
|
|
"description": [
|
|
"\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.APP_WRAPPER_CLASS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "APP_WRAPPER_CLASS",
|
|
"description": [
|
|
"\nThe class name for top level *and* nested application wrappers to ensure proper layout"
|
|
],
|
|
"signature": [
|
|
"\"kbnAppWrapper\""
|
|
],
|
|
"path": "src/core/utils/app_wrapper_class.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.DomainDeprecationDetails",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DomainDeprecationDetails",
|
|
"description": [],
|
|
"signature": [
|
|
"DeprecationsDetails",
|
|
" & { domainId: string; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.EventType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EventType",
|
|
"description": [
|
|
"\nEvent Type used for indexed structures. Only used to improve the readability of the types"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ExecutionContextStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExecutionContextStart",
|
|
"description": [
|
|
"\nSee {@link ExecutionContextSetup}."
|
|
],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.FatalErrorsStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FatalErrorsStart",
|
|
"description": [
|
|
"\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n"
|
|
],
|
|
"signature": [
|
|
"FatalErrorsSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.HttpStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HttpStart",
|
|
"description": [
|
|
"\nSee {@link HttpSetup}"
|
|
],
|
|
"signature": [
|
|
"HttpSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.IToasts",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IToasts",
|
|
"description": [
|
|
"\nMethods for adding and removing global toast messages. See {@link ToastsApi}."
|
|
],
|
|
"signature": [
|
|
"{ 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"
|
|
},
|
|
"; get$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.KibanaExecutionContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaExecutionContext",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; child?: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.MountPoint",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MountPoint",
|
|
"description": [
|
|
"\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n"
|
|
],
|
|
"signature": [
|
|
"(element: T) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.UnmountCallback",
|
|
"text": "UnmountCallback"
|
|
}
|
|
],
|
|
"path": "src/core/public/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [
|
|
"a {@link UnmountCallback } that unmount the element on call."
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.MountPoint.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "element",
|
|
"description": [
|
|
"the container element to render into"
|
|
],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/core/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PluginInitializer",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PluginInitializer",
|
|
"description": [
|
|
"\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n"
|
|
],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<object>) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<TSetup, TStart, TPluginsSetup, TPluginsStart>"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PluginInitializer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<object>"
|
|
],
|
|
"path": "src/core/public/plugins/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PluginOpaqueId",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PluginOpaqueId",
|
|
"description": [],
|
|
"signature": [
|
|
"symbol"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.PublicUiSettingsParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicUiSettingsParams",
|
|
"description": [
|
|
"\nA sub-set of {@link UiSettingsParams} exposed to the client-side."
|
|
],
|
|
"signature": [
|
|
"{ metric?: { type: string; name: string; } | undefined; type?: ",
|
|
"UiSettingsType",
|
|
" | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; description?: string | undefined; options?: number[] | string[] | undefined; category?: string[] | undefined; optionLabels?: Record<string, string> | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ",
|
|
"DeprecationSettings",
|
|
" | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ResolveDeprecationResponse",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ResolveDeprecationResponse",
|
|
"description": [
|
|
"\nResponse from correctiveActions.api call from automatically resolving the deprecation"
|
|
],
|
|
"signature": [
|
|
"{ status: \"ok\"; } | { status: \"fail\"; reason: string; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectAttribute",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectAttribute",
|
|
"description": [
|
|
"\nType definition for a Saved Object attribute value\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectAttributeSingle",
|
|
" | ",
|
|
"SavedObjectAttributeSingle",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectAttributeSingle",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectAttributeSingle",
|
|
"description": [
|
|
"\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n"
|
|
],
|
|
"signature": [
|
|
"string | number | boolean | ",
|
|
"SavedObjectAttributes",
|
|
" | null | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsFindOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectsFindOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string | string[]; filter?: any; search?: string | undefined; page?: number | undefined; aggs?: Record<string, ",
|
|
"AggregationsAggregationContainer",
|
|
"> | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; searchFields?: string[] | undefined; hasReference?: ",
|
|
"SavedObjectsFindOptionsReference",
|
|
" | ",
|
|
"SavedObjectsFindOptionsReference",
|
|
"[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; preference?: string | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsImportWarning",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportWarning",
|
|
"description": [
|
|
"\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportSimpleWarning",
|
|
" | ",
|
|
"SavedObjectsImportActionRequiredWarning"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.SavedObjectsNamespaceType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectsNamespaceType",
|
|
"description": [
|
|
"\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n"
|
|
],
|
|
"signature": [
|
|
"\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.StartServicesAccessor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "StartServicesAccessor",
|
|
"description": [
|
|
"\nAllows plugins to get access to APIs available in start inside async\nhandlers, such as {@link App.mount}. Promise will not resolve until Core\nand plugin dependencies have completed `start`.\n"
|
|
],
|
|
"signature": [
|
|
"() => Promise<[",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", TPluginsStart, TStart]>"
|
|
],
|
|
"path": "src/core/public/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.TelemetryCounterType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TelemetryCounterType",
|
|
"description": [
|
|
"\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason."
|
|
],
|
|
"signature": [
|
|
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.Toast",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Toast",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"Toast",
|
|
", \"children\" | \"color\" | \"className\" | \"lang\" | \"style\" | \"role\" | \"tabIndex\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"data-test-subj\" | \"hidden\" | \"security\" | \"defaultValue\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\"> & { title?: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement> | undefined; text?: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement> | undefined; } & { id: string; }"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastInput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ToastInput",
|
|
"description": [
|
|
"\nInputs for {@link IToasts} APIs."
|
|
],
|
|
"signature": [
|
|
"string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastInputFields",
|
|
"text": "ToastInputFields"
|
|
}
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastInputFields",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ToastInputFields",
|
|
"description": [
|
|
"\nAllowed fields for {@link ToastInput}.\n"
|
|
],
|
|
"signature": [
|
|
"Pick<",
|
|
"Toast",
|
|
", \"children\" | \"color\" | \"className\" | \"lang\" | \"style\" | \"role\" | \"tabIndex\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"data-test-subj\" | \"hidden\" | \"security\" | \"defaultValue\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\"> & { title?: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement> | undefined; text?: string | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.MountPoint",
|
|
"text": "MountPoint"
|
|
},
|
|
"<HTMLElement> | undefined; }"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_api.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ToastsSetup",
|
|
"description": [
|
|
"\n{@link IToasts}"
|
|
],
|
|
"signature": [
|
|
"{ 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"
|
|
},
|
|
"; get$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_service.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.ToastsStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ToastsStart",
|
|
"description": [
|
|
"\n{@link IToasts}"
|
|
],
|
|
"signature": [
|
|
"{ 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"
|
|
},
|
|
"; get$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/core/public/notifications/toasts/toasts_service.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UiSettingsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UiSettingsType",
|
|
"description": [
|
|
"\nUI element type to represent the settings."
|
|
],
|
|
"signature": [
|
|
"\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"image\" | \"json\" | \"markdown\" | \"select\" | \"array\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.UnmountCallback",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UnmountCallback",
|
|
"description": [
|
|
"\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n"
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/core/public/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-public.URL_MAX_LENGTH",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "URL_MAX_LENGTH",
|
|
"description": [
|
|
"\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit."
|
|
],
|
|
"signature": [
|
|
"2000 | 25000"
|
|
],
|
|
"path": "src/core/public/core_app/errors/url_overflow.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CspConfig",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "CspConfig",
|
|
"description": [
|
|
"\nCSP configuration for use in Kibana."
|
|
],
|
|
"signature": [
|
|
"CspConfig",
|
|
" implements ",
|
|
"ICspConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CspConfig.private",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "#private",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CspConfig.DEFAULT",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT",
|
|
"description": [],
|
|
"signature": [
|
|
"CspConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CspConfig.strict",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "strict",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CspConfig.warnLegacyBrowsers",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "warnLegacyBrowsers",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CspConfig.disableEmbedding",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "disableEmbedding",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CspConfig.header",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "header",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventLoopDelaysMonitor",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "EventLoopDelaysMonitor",
|
|
"description": [],
|
|
"signature": [
|
|
"EventLoopDelaysMonitor",
|
|
" implements ",
|
|
"IEventLoopDelaysMonitor",
|
|
"<",
|
|
"IntervalHistogram",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventLoopDelaysMonitor.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [
|
|
"\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays."
|
|
],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventLoopDelaysMonitor.collect",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "collect",
|
|
"description": [
|
|
"\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds.\n "
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"IntervalHistogram"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventLoopDelaysMonitor.reset",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reset",
|
|
"description": [
|
|
"\nResets the collected histogram data."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventLoopDelaysMonitor.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [
|
|
"\nDisables updating the interval timer for collecting new data points."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "RouteValidationError",
|
|
"description": [
|
|
"\nError to return when the validation is not successful."
|
|
],
|
|
"signature": [
|
|
"RouteValidationError",
|
|
" extends ",
|
|
"SchemaTypeError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationError.Unnamed.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationError.Unnamed.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.pollEsNodesVersion",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "pollEsNodesVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"({ internalClient, log, kibanaVersion, ignoreVersionMismatch, esVersionCheckInterval: healthCheckInterval, }: ",
|
|
"PollEsNodesVersionOptions",
|
|
") => ",
|
|
"Observable",
|
|
"<",
|
|
"NodesVersionCompatibility",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.pollEsNodesVersion.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
"PollEsNodesVersionOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AnalyticsClient",
|
|
"description": [
|
|
"\nAnalytics client's public APIs"
|
|
],
|
|
"signature": [
|
|
"AnalyticsClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.reportEvent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportEvent",
|
|
"description": [
|
|
"\nReports a telemetry event."
|
|
],
|
|
"signature": [
|
|
"<EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.reportEvent.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "eventType",
|
|
"description": [
|
|
"The event type registered via the `registerEventType` API."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.reportEvent.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "eventData",
|
|
"description": [
|
|
"The properties matching the schema declared in the `registerEventType` API."
|
|
],
|
|
"signature": [
|
|
"EventTypeData"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerEventType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEventType",
|
|
"description": [
|
|
"\nRegisters the event type that will be emitted via the reportEvent API."
|
|
],
|
|
"signature": [
|
|
"<EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerEventType.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "eventTypeOps",
|
|
"description": [
|
|
"The definition of the event type {@link EventTypeOpts }."
|
|
],
|
|
"signature": [
|
|
"EventTypeOpts",
|
|
"<EventTypeData>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerShipper",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerShipper",
|
|
"description": [
|
|
"\nSet up the shipper that will be used to report the telemetry events."
|
|
],
|
|
"signature": [
|
|
"<Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerShipper.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "Shipper",
|
|
"description": [
|
|
"The {@link IShipper } class to instantiate the shipper."
|
|
],
|
|
"signature": [
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerShipper.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "shipperConfig",
|
|
"description": [
|
|
"The config specific to the Shipper to instantiate."
|
|
],
|
|
"signature": [
|
|
"ShipperConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerShipper.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [
|
|
"Additional options to register the shipper {@link RegisterShipperOpts }."
|
|
],
|
|
"signature": [
|
|
"RegisterShipperOpts",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.optIn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "optIn",
|
|
"description": [
|
|
"\nUsed to control the user's consent to report the data.\nIn the advanced mode, it allows to \"cherry-pick\" which events and shippers are enabled/disabled."
|
|
],
|
|
"signature": [
|
|
"(optInConfig: ",
|
|
"OptInConfig",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.optIn.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "optInConfig",
|
|
"description": [
|
|
"{@link OptInConfig }"
|
|
],
|
|
"signature": [
|
|
"OptInConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerContextProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerContextProvider",
|
|
"description": [
|
|
"\nRegisters the context provider to enrich the any reported events."
|
|
],
|
|
"signature": [
|
|
"<Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.registerContextProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contextProviderOpts",
|
|
"description": [
|
|
"{@link ContextProviderOpts }"
|
|
],
|
|
"signature": [
|
|
"ContextProviderOpts",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.removeContextProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeContextProvider",
|
|
"description": [
|
|
"\nRemoves the context provider and stop enriching the events from its context."
|
|
],
|
|
"signature": [
|
|
"(contextProviderName: string) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.removeContextProvider.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "contextProviderName",
|
|
"description": [
|
|
"The name of the context provider to remove."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.telemetryCounter$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryCounter$",
|
|
"description": [
|
|
"\nObservable to emit the stats of the processed events."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsClient.shutdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shutdown",
|
|
"description": [
|
|
"\nStops the client."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AppCategory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AppCategory",
|
|
"description": [
|
|
"\n\nA category definition for nav links to know where to sort them in the left hand nav"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AppCategory.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nUnique identifier for the categories"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AppCategory.label",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "label",
|
|
"description": [
|
|
"\nLabel used for category name.\nAlso used as aria-label if one isn't set."
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AppCategory.ariaLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ariaLabel",
|
|
"description": [
|
|
"\nIf the visual label isn't appropriate for screen readers,\ncan override it here"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AppCategory.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [
|
|
"\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AppCategory.euiIconType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "euiIconType",
|
|
"description": [
|
|
"\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/types/app_category.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin",
|
|
"type": "Interface",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "AsyncPlugin",
|
|
"description": [
|
|
"\nA plugin with asynchronous lifecycle methods.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.AsyncPlugin",
|
|
"text": "AsyncPlugin"
|
|
},
|
|
"<TSetup, TStart, TPluginsSetup, TPluginsStart>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": true,
|
|
"removeBy": "8.8.0",
|
|
"references": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, plugins: TPluginsSetup) => TSetup | Promise<TSetup>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin.setup.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
"TPluginsSetup"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", plugins: TPluginsStart) => TStart | Promise<TStart>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin.start.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
"TPluginsStart"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AsyncPlugin.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthRedirectedParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AuthRedirectedParams",
|
|
"description": [
|
|
"\nResult of auth redirection."
|
|
],
|
|
"signature": [
|
|
"AuthRedirectedParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthRedirectedParams.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"\nHeaders to attach for auth redirect.\nMust include \"location\" header"
|
|
],
|
|
"signature": [
|
|
"{ location: string; } & ",
|
|
"ResponseHeaders"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultAuthenticated",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AuthResultAuthenticated",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultAuthenticated",
|
|
" extends ",
|
|
"AuthResultParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultAuthenticated.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultType",
|
|
".authenticated"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultNotHandled",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AuthResultNotHandled",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultNotHandled"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultNotHandled.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultType",
|
|
".notHandled"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AuthResultParams",
|
|
"description": [
|
|
"\nResult of successful authentication."
|
|
],
|
|
"signature": [
|
|
"AuthResultParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultParams.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [
|
|
"\nData to associate with an incoming request. Any downstream plugin may get access to the data."
|
|
],
|
|
"signature": [
|
|
"Record<string, any> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultParams.requestHeaders",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requestHeaders",
|
|
"description": [
|
|
"\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user."
|
|
],
|
|
"signature": [
|
|
"AuthHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultParams.responseHeaders",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "responseHeaders",
|
|
"description": [
|
|
"\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed."
|
|
],
|
|
"signature": [
|
|
"AuthHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultRedirected",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AuthResultRedirected",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultRedirected",
|
|
" extends ",
|
|
"AuthRedirectedParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultRedirected.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultType",
|
|
".redirected"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthToolkit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "AuthToolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthToolkit.authenticated",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "authenticated",
|
|
"description": [
|
|
"Authentication is successful with given credentials, allow request to pass through"
|
|
],
|
|
"signature": [
|
|
"(data?: ",
|
|
"AuthResultParams",
|
|
" | undefined) => ",
|
|
"AuthResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthToolkit.authenticated.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultParams",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthToolkit.notHandled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "notHandled",
|
|
"description": [
|
|
"\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"AuthResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthToolkit.redirected",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "redirected",
|
|
"description": [
|
|
"\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'"
|
|
],
|
|
"signature": [
|
|
"(headers: { location: string; } & ",
|
|
"ResponseHeaders",
|
|
") => ",
|
|
"AuthResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthToolkit.redirected.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [],
|
|
"signature": [
|
|
"{ location: string; } & ",
|
|
"ResponseHeaders"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Capabilities",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Capabilities",
|
|
"description": [
|
|
"\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n"
|
|
],
|
|
"signature": [
|
|
"Capabilities"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Capabilities.navLinks",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "navLinks",
|
|
"description": [
|
|
"Navigation link capabilities."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: boolean; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Capabilities.management",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "management",
|
|
"description": [
|
|
"Management section capabilities."
|
|
],
|
|
"signature": [
|
|
"{ [sectionId: string]: Record<string, boolean>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Capabilities.catalogue",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "catalogue",
|
|
"description": [
|
|
"Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: boolean; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Capabilities.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: Record<string, boolean | Record<string, boolean>>",
|
|
"description": [
|
|
"Custom capabilities, registered by plugins."
|
|
],
|
|
"signature": [
|
|
"[key: string]: Record<string, boolean | Record<string, boolean>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CapabilitiesSetup",
|
|
"description": [
|
|
"\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n"
|
|
],
|
|
"signature": [
|
|
"CapabilitiesSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSetup.registerProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerProvider",
|
|
"description": [
|
|
"\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n"
|
|
],
|
|
"signature": [
|
|
"(provider: ",
|
|
"CapabilitiesProvider",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSetup.registerProvider.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "provider",
|
|
"description": [],
|
|
"signature": [
|
|
"CapabilitiesProvider"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSetup.registerSwitcher",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerSwitcher",
|
|
"description": [
|
|
"\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n"
|
|
],
|
|
"signature": [
|
|
"(switcher: ",
|
|
"CapabilitiesSwitcher",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSetup.registerSwitcher.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "switcher",
|
|
"description": [],
|
|
"signature": [
|
|
"CapabilitiesSwitcher"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CapabilitiesStart",
|
|
"description": [
|
|
"\nAPIs to access the application {@link Capabilities}.\n"
|
|
],
|
|
"signature": [
|
|
"CapabilitiesStart"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesStart.resolveCapabilities",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "resolveCapabilities",
|
|
"description": [
|
|
"\nResolve the {@link Capabilities} to be used for given request"
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, options?: ",
|
|
"ResolveCapabilitiesOptions",
|
|
" | undefined) => Promise<",
|
|
"Capabilities",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesStart.resolveCapabilities.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesStart.resolveCapabilities.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"ResolveCapabilitiesOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ConfigDeprecationContext",
|
|
"description": [
|
|
"\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\n"
|
|
],
|
|
"signature": [
|
|
"ConfigDeprecationContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationContext.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"The current Kibana version, e.g `7.16.1`, `8.0.0`"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationContext.branch",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "branch",
|
|
"description": [
|
|
"The current Kibana branch, e.g `7.x`, `7.16`, `master`"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationContext.docLinks",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "docLinks",
|
|
"description": [
|
|
"Allow direct access to the doc links from the deprecation handler"
|
|
],
|
|
"signature": [
|
|
"DocLinks"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ConfigDeprecationFactory",
|
|
"description": [
|
|
"\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n"
|
|
],
|
|
"signature": [
|
|
"ConfigDeprecationFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deprecate",
|
|
"description": [
|
|
"\nDeprecate a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the deprecatedKey was found.\n"
|
|
],
|
|
"signature": [
|
|
"(deprecatedKey: string, removeBy: string, details: ",
|
|
"FactoryConfigDeprecationDetails",
|
|
") => ",
|
|
"ConfigDeprecation"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecate.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deprecatedKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecate.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "removeBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecate.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"FactoryConfigDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecateFromRoot",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deprecateFromRoot",
|
|
"description": [
|
|
"\nDeprecate a configuration property from the root configuration.\nWill log a deprecation warning if the deprecatedKey was found.\n\nThis should be only used when deprecating properties from different configuration's path.\nTo deprecate properties from inside a plugin's configuration, use 'deprecate' instead.\n"
|
|
],
|
|
"signature": [
|
|
"(deprecatedKey: string, removeBy: string, details: ",
|
|
"FactoryConfigDeprecationDetails",
|
|
") => ",
|
|
"ConfigDeprecation"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "deprecatedKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "removeBy",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"FactoryConfigDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.rename",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "rename",
|
|
"description": [
|
|
"\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n"
|
|
],
|
|
"signature": [
|
|
"(oldKey: string, newKey: string, details: ",
|
|
"FactoryConfigDeprecationDetails",
|
|
") => ",
|
|
"ConfigDeprecation"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.rename.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "oldKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.rename.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "newKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.rename.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"FactoryConfigDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.renameFromRoot",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renameFromRoot",
|
|
"description": [
|
|
"\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n"
|
|
],
|
|
"signature": [
|
|
"(oldKey: string, newKey: string, details: ",
|
|
"FactoryConfigDeprecationDetails",
|
|
") => ",
|
|
"ConfigDeprecation"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "oldKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "newKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"FactoryConfigDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.unused",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "unused",
|
|
"description": [
|
|
"\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n"
|
|
],
|
|
"signature": [
|
|
"(unusedKey: string, details: ",
|
|
"FactoryConfigDeprecationDetails",
|
|
") => ",
|
|
"ConfigDeprecation"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.unused.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "unusedKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.unused.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"FactoryConfigDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.unusedFromRoot",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "unusedFromRoot",
|
|
"description": [
|
|
"\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n"
|
|
],
|
|
"signature": [
|
|
"(unusedKey: string, details: ",
|
|
"FactoryConfigDeprecationDetails",
|
|
") => ",
|
|
"ConfigDeprecation"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "unusedKey",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"FactoryConfigDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ContextProviderOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ContextProviderOpts",
|
|
"description": [
|
|
"\nDefinition of a context provider"
|
|
],
|
|
"signature": [
|
|
"ContextProviderOpts",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ContextProviderOpts.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nThe name of the provider."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ContextProviderOpts.context$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context$",
|
|
"description": [
|
|
"\nObservable that emits the custom context."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ContextProviderOpts.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [
|
|
"\nSchema declaring and documenting the expected output in the context$\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<Context>]: ",
|
|
"SchemaValue",
|
|
"<Context[Key]>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CorePreboot",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CorePreboot",
|
|
"description": [
|
|
"\nContext passed to the `setup` method of `preboot` plugins."
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CorePreboot.analytics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analytics",
|
|
"description": [
|
|
"{@link AnalyticsServicePreboot}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CorePreboot.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [
|
|
"{@link ElasticsearchServicePreboot}"
|
|
],
|
|
"signature": [
|
|
"ElasticsearchServicePreboot"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CorePreboot.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [
|
|
"{@link HttpServicePreboot}"
|
|
],
|
|
"signature": [
|
|
"HttpServicePreboot",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CorePreboot.preboot",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "preboot",
|
|
"description": [
|
|
"{@link PrebootServicePreboot}"
|
|
],
|
|
"signature": [
|
|
"PrebootServicePreboot"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CoreRequestHandlerContext",
|
|
"description": [
|
|
"\nThe `core` context provided to route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request"
|
|
],
|
|
"path": "src/core/server/core_route_handler_context.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreRequestHandlerContext.savedObjects",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjects",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRequestHandlerContext",
|
|
"text": "SavedObjectsRequestHandlerContext"
|
|
}
|
|
],
|
|
"path": "src/core/server/core_route_handler_context.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreRequestHandlerContext.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [],
|
|
"signature": [
|
|
"ElasticsearchRequestHandlerContext"
|
|
],
|
|
"path": "src/core/server/core_route_handler_context.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreRequestHandlerContext.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.UiSettingsRequestHandlerContext",
|
|
"text": "UiSettingsRequestHandlerContext"
|
|
}
|
|
],
|
|
"path": "src/core/server/core_route_handler_context.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreRequestHandlerContext.deprecations",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deprecations",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.DeprecationsRequestHandlerContext",
|
|
"text": "DeprecationsRequestHandlerContext"
|
|
}
|
|
],
|
|
"path": "src/core/server/core_route_handler_context.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CoreSetup",
|
|
"description": [
|
|
"\nContext passed to the `setup` method of `standard` plugins.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<TPluginsStart, TStart>"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.analytics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analytics",
|
|
"description": [
|
|
"{@link AnalyticsServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.capabilities",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "capabilities",
|
|
"description": [
|
|
"{@link CapabilitiesSetup}"
|
|
],
|
|
"signature": [
|
|
"CapabilitiesSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.docLinks",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "docLinks",
|
|
"description": [
|
|
"{@link DocLinksServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"DocLinksServiceSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [
|
|
"{@link ElasticsearchServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"ElasticsearchServiceSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.executionContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionContext",
|
|
"description": [
|
|
"{@link ExecutionContextSetup}"
|
|
],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.http",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [
|
|
"{@link HttpServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"HttpServiceSetup",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
"> & { resources: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResources",
|
|
"text": "HttpResources"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.i18n",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "i18n",
|
|
"description": [
|
|
"{@link I18nServiceSetup}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.I18nServiceSetup",
|
|
"text": "I18nServiceSetup"
|
|
}
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.logging",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logging",
|
|
"description": [
|
|
"{@link LoggingServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"LoggingServiceSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.metrics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [
|
|
"{@link MetricsServiceSetup}"
|
|
],
|
|
"signature": [
|
|
"MetricsServiceSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.savedObjects",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjects",
|
|
"description": [
|
|
"{@link SavedObjectsServiceSetup}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsServiceSetup",
|
|
"text": "SavedObjectsServiceSetup"
|
|
}
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.status",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [
|
|
"{@link StatusServiceSetup}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.StatusServiceSetup",
|
|
"text": "StatusServiceSetup"
|
|
}
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [
|
|
"{@link UiSettingsServiceSetup}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.UiSettingsServiceSetup",
|
|
"text": "UiSettingsServiceSetup"
|
|
}
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.deprecations",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deprecations",
|
|
"description": [
|
|
"{@link DeprecationsServiceSetup}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.DeprecationsServiceSetup",
|
|
"text": "DeprecationsServiceSetup"
|
|
}
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreSetup.getStartServices",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStartServices",
|
|
"description": [
|
|
"{@link StartServicesAccessor}"
|
|
],
|
|
"signature": [
|
|
"() => Promise<[",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", TPluginsStart, TStart]>"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CoreStart",
|
|
"description": [
|
|
"\nContext passed to the plugins `start` method.\n"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.analytics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analytics",
|
|
"description": [
|
|
"{@link AnalyticsServiceStart}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; }"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.capabilities",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "capabilities",
|
|
"description": [
|
|
"{@link CapabilitiesStart}"
|
|
],
|
|
"signature": [
|
|
"CapabilitiesStart"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.docLinks",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "docLinks",
|
|
"description": [
|
|
"{@link DocLinksServiceStart}"
|
|
],
|
|
"signature": [
|
|
"DocLinksServiceSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [
|
|
"{@link ElasticsearchServiceStart}"
|
|
],
|
|
"signature": [
|
|
"ElasticsearchServiceStart"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.executionContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionContext",
|
|
"description": [
|
|
"{@link ExecutionContextStart}"
|
|
],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.http",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "http",
|
|
"description": [
|
|
"{@link HttpServiceStart}"
|
|
],
|
|
"signature": [
|
|
"HttpServiceStart"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.metrics",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [
|
|
"{@link MetricsServiceStart}"
|
|
],
|
|
"signature": [
|
|
"MetricsServiceSetup"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.savedObjects",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjects",
|
|
"description": [
|
|
"{@link SavedObjectsServiceStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsServiceStart",
|
|
"text": "SavedObjectsServiceStart"
|
|
}
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStart.uiSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [
|
|
"{@link UiSettingsServiceStart}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.UiSettingsServiceStart",
|
|
"text": "UiSettingsServiceStart"
|
|
}
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStatus",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CoreStatus",
|
|
"description": [
|
|
"\nStatus of core services.\n"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStatus.elasticsearch",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "elasticsearch",
|
|
"description": [],
|
|
"signature": [
|
|
"ServiceStatus",
|
|
"<unknown>"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CoreStatus.savedObjects",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjects",
|
|
"description": [],
|
|
"signature": [
|
|
"ServiceStatus",
|
|
"<unknown>"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CustomHttpResponseOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CustomHttpResponseOptions",
|
|
"description": [
|
|
"\nHTTP response parameters for a response with adjustable status code."
|
|
],
|
|
"signature": [
|
|
"CustomHttpResponseOptions",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CustomHttpResponseOptions.body",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"HTTP message to send to the client"
|
|
],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CustomHttpResponseOptions.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"HTTP Headers with additional information about response"
|
|
],
|
|
"signature": [
|
|
"ResponseHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CustomHttpResponseOptions.bypassErrorFormat",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "bypassErrorFormat",
|
|
"description": [
|
|
"Bypass the default error formatting"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CustomHttpResponseOptions.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeprecationsClient",
|
|
"description": [
|
|
"\nServer-side client that provides access to fetch all Kibana deprecations\n"
|
|
],
|
|
"path": "src/core/server/deprecations/deprecations_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsClient.getAllDeprecations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllDeprecations",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"DomainDeprecationDetails",
|
|
"[]>"
|
|
],
|
|
"path": "src/core/server/deprecations/deprecations_service.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationSettings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeprecationSettings",
|
|
"description": [
|
|
"\nUiSettings deprecation field options."
|
|
],
|
|
"signature": [
|
|
"DeprecationSettings"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationSettings.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"Deprecation message"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationSettings.docLinksKey",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "docLinksKey",
|
|
"description": [
|
|
"Key to documentation links"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeprecationsRequestHandlerContext",
|
|
"description": [
|
|
"\nCore's `deprecations` request handler context."
|
|
],
|
|
"path": "src/core/server/deprecations/deprecations_route_handler_context.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsRequestHandlerContext.client",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "client",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.DeprecationsClient",
|
|
"text": "DeprecationsClient"
|
|
}
|
|
],
|
|
"path": "src/core/server/deprecations/deprecations_route_handler_context.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DeprecationsServiceSetup",
|
|
"description": [
|
|
"\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n"
|
|
],
|
|
"path": "src/core/server/deprecations/deprecations_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsServiceSetup.registerDeprecations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerDeprecations",
|
|
"description": [],
|
|
"signature": [
|
|
"(deprecationContext: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RegisterDeprecationsConfig",
|
|
"text": "RegisterDeprecationsConfig"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "src/core/server/deprecations/deprecations_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsServiceSetup.registerDeprecations.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deprecationContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RegisterDeprecationsConfig",
|
|
"text": "RegisterDeprecationsConfig"
|
|
}
|
|
],
|
|
"path": "src/core/server/deprecations/deprecations_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DiscoveredPlugin",
|
|
"description": [
|
|
"\nSmall container object used to expose information about discovered plugins that may\nor may not have been started."
|
|
],
|
|
"signature": [
|
|
"DiscoveredPlugin"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nIdentifier of the plugin."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin.configPath",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "configPath",
|
|
"description": [
|
|
"\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format."
|
|
],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin.type",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nType of the plugin, defaults to `standard`."
|
|
],
|
|
"signature": [
|
|
"PluginType"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin.requiredPlugins",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requiredPlugins",
|
|
"description": [
|
|
"\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly."
|
|
],
|
|
"signature": [
|
|
"readonly string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin.optionalPlugins",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "optionalPlugins",
|
|
"description": [
|
|
"\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly."
|
|
],
|
|
"signature": [
|
|
"readonly string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin.requiredBundles",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requiredBundles",
|
|
"description": [
|
|
"\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n"
|
|
],
|
|
"signature": [
|
|
"readonly string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DiscoveredPlugin.enabledOnAnonymousPages",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "enabledOnAnonymousPages",
|
|
"description": [
|
|
"\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DocLinksServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DocLinksServiceSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"DocLinksServiceSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DocLinksServiceSetup.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"The branch/version the docLinks are pointing to"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DocLinksServiceSetup.elasticWebsiteUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "elasticWebsiteUrl",
|
|
"description": [
|
|
"The base url for the elastic website"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DocLinksServiceSetup.links",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "links",
|
|
"description": [
|
|
"A record of all registered doc links"
|
|
],
|
|
"signature": [
|
|
"DocLinks"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchClientConfig",
|
|
"description": [
|
|
"\nConfiguration options to be used to create a {@link IClusterClient | cluster client}\n"
|
|
],
|
|
"signature": [
|
|
"ElasticsearchClientConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.customHeaders",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "customHeaders",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: string; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.requestHeadersWhitelist",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "requestHeadersWhitelist",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.maxSockets",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxSockets",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.compression",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "compression",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.sniffOnStart",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "sniffOnStart",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.sniffOnConnectionFault",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "sniffOnConnectionFault",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.sniffInterval",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sniffInterval",
|
|
"description": [],
|
|
"signature": [
|
|
"false | moment.Duration"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.username",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "username",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.password",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "password",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.serviceAccountToken",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "serviceAccountToken",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.hosts",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "hosts",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.keepAlive",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "keepAlive",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.pingTimeout",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "pingTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"number | moment.Duration | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.requestTimeout",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requestTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"number | moment.Duration | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.caFingerprint",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "caFingerprint",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientConfig.ssl",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ssl",
|
|
"description": [],
|
|
"signature": [
|
|
"ElasticsearchClientSslConfig",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientSslConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchClientSslConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"ElasticsearchClientSslConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientSslConfig.verificationMode",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "verificationMode",
|
|
"description": [],
|
|
"signature": [
|
|
"\"none\" | \"full\" | \"certificate\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientSslConfig.certificate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "certificate",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientSslConfig.certificateAuthorities",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "certificateAuthorities",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientSslConfig.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientSslConfig.keyPassphrase",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keyPassphrase",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClientSslConfig.alwaysPresentCertificate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "alwaysPresentCertificate",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchConfigPreboot",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchConfigPreboot",
|
|
"description": [
|
|
"\nA limited set of Elasticsearch configuration entries exposed to the `preboot` plugins at `setup`.\n"
|
|
],
|
|
"signature": [
|
|
"ElasticsearchConfigPreboot"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchConfigPreboot.hosts",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "hosts",
|
|
"description": [
|
|
"\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchConfigPreboot.credentialsSpecified",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "credentialsSpecified",
|
|
"description": [
|
|
"\nIndicates whether Elasticsearch configuration includes credentials (`username`, `password` or `serviceAccountToken`)."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchRequestHandlerContext",
|
|
"description": [
|
|
"\nCore's `elasticsearch` request handler context."
|
|
],
|
|
"signature": [
|
|
"ElasticsearchRequestHandlerContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchRequestHandlerContext.client",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "client",
|
|
"description": [],
|
|
"signature": [
|
|
"IScopedClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServicePreboot",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchServicePreboot",
|
|
"description": [],
|
|
"signature": [
|
|
"ElasticsearchServicePreboot"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServicePreboot.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [
|
|
"\nA limited set of Elasticsearch configuration entries.\n"
|
|
],
|
|
"signature": [
|
|
"{ readonly hosts: string[]; readonly credentialsSpecified: boolean; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServicePreboot.createClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createClient",
|
|
"description": [
|
|
"\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n"
|
|
],
|
|
"signature": [
|
|
"(type: string, clientConfig?: Partial<",
|
|
"ElasticsearchClientConfig",
|
|
"> | undefined) => ",
|
|
"ICustomClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServicePreboot.createClient.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"Unique identifier of the client"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServicePreboot.createClient.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "clientConfig",
|
|
"description": [
|
|
"A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid."
|
|
],
|
|
"signature": [
|
|
"Partial<",
|
|
"ElasticsearchClientConfig",
|
|
"> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchServiceSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"ElasticsearchServiceSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setUnauthorizedErrorHandler",
|
|
"description": [
|
|
"\nRegister a handler that will be called when unauthorized (401) errors are returned from any API\ncall to elasticsearch performed on behalf of a user via a {@link IScopedClusterClient | scoped cluster client}.\n"
|
|
],
|
|
"signature": [
|
|
"(handler: ",
|
|
"UnauthorizedErrorHandler",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceSetup.legacy",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "legacy",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly config$: ",
|
|
"Observable",
|
|
"<",
|
|
"IElasticsearchConfig",
|
|
">; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "console",
|
|
"path": "src/plugins/console/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-elasticsearch-server-internal",
|
|
"path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-elasticsearch-server-internal",
|
|
"path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ElasticsearchServiceStart",
|
|
"description": [],
|
|
"signature": [
|
|
"ElasticsearchServiceStart"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceStart.client",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "client",
|
|
"description": [
|
|
"\nA pre-configured {@link IClusterClient | Elasticsearch client}\n"
|
|
],
|
|
"signature": [
|
|
"IClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceStart.createClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createClient",
|
|
"description": [
|
|
"\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n"
|
|
],
|
|
"signature": [
|
|
"(type: string, clientConfig?: Partial<",
|
|
"ElasticsearchClientConfig",
|
|
"> | undefined) => ",
|
|
"ICustomClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceStart.createClient.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"Unique identifier of the client"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchServiceStart.createClient.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "clientConfig",
|
|
"description": [
|
|
"A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid."
|
|
],
|
|
"signature": [
|
|
"Partial<",
|
|
"ElasticsearchClientConfig",
|
|
"> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EnvironmentMode",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EnvironmentMode",
|
|
"description": [],
|
|
"signature": [
|
|
"EnvironmentMode"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EnvironmentMode.name",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"signature": [
|
|
"\"production\" | \"development\""
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EnvironmentMode.dev",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "dev",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EnvironmentMode.prod",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "prod",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ErrorHttpResponseOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ErrorHttpResponseOptions",
|
|
"description": [
|
|
"\nHTTP response parameters"
|
|
],
|
|
"signature": [
|
|
"ErrorHttpResponseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ErrorHttpResponseOptions.body",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"HTTP message to send to the client"
|
|
],
|
|
"signature": [
|
|
"ResponseError",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ErrorHttpResponseOptions.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"HTTP Headers with additional information about response"
|
|
],
|
|
"signature": [
|
|
"ResponseHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Event",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Event",
|
|
"description": [
|
|
"\nDefinition of the full event structure"
|
|
],
|
|
"signature": [
|
|
"Event"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Event.timestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timestamp",
|
|
"description": [
|
|
"\nThe time the event was generated in ISO format."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Event.event_type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "event_type",
|
|
"description": [
|
|
"\nThe event type."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Event.properties",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "properties",
|
|
"description": [
|
|
"\nThe specific properties of the event type."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: unknown; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Event.context",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [
|
|
"\nThe {@link EventContext} enriched during the processing pipeline."
|
|
],
|
|
"signature": [
|
|
"EventContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EventContext",
|
|
"description": [
|
|
"\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}."
|
|
],
|
|
"signature": [
|
|
"EventContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.cluster_uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cluster_uuid",
|
|
"description": [
|
|
"\nThe UUID of the cluster"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.cluster_name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cluster_name",
|
|
"description": [
|
|
"\nThe name of the cluster."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.license_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "license_id",
|
|
"description": [
|
|
"\nThe license ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.userId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "userId",
|
|
"description": [
|
|
"\nThe unique user ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.cloudId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cloudId",
|
|
"description": [
|
|
"\nThe Cloud ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.isElasticCloudUser",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isElasticCloudUser",
|
|
"description": [
|
|
"\n`true` if the user is logged in via the Elastic Cloud authentication provider."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nThe product's version."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.pageName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pageName",
|
|
"description": [
|
|
"\nThe name of the current page."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.applicationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "applicationId",
|
|
"description": [
|
|
"\nThe current application ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.entityId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "entityId",
|
|
"description": [
|
|
"\nThe current entity ID (dashboard ID, visualization ID, etc.)."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventContext.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: unknown",
|
|
"description": [
|
|
"\nAdditional keys are allowed."
|
|
],
|
|
"signature": [
|
|
"[key: string]: unknown"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventTypeOpts",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EventTypeOpts",
|
|
"description": [
|
|
"\nDefinition of an Event Type."
|
|
],
|
|
"signature": [
|
|
"EventTypeOpts",
|
|
"<EventTypeData>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventTypeOpts.eventType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "eventType",
|
|
"description": [
|
|
"\nThe event type's unique name."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventTypeOpts.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [
|
|
"\nSchema declaring and documenting the expected structure of this event type.\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof Required<EventTypeData>]: ",
|
|
"SchemaValue",
|
|
"<EventTypeData[Key]>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ExecutionContextSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ExecutionContextSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ExecutionContextSetup.withContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "withContext",
|
|
"description": [
|
|
"\nKeeps track of execution context while the passed function is executed.\nData are carried over all async operations spawned by the passed function.\nThe nested calls stack the registered context on top of each other."
|
|
],
|
|
"signature": [
|
|
"<R>(context: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined, fn: (...args: any[]) => R) => R"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ExecutionContextSetup.withContext.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaExecutionContext",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ExecutionContextSetup.withContext.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fn",
|
|
"description": [],
|
|
"signature": [
|
|
"(...args: any[]) => R"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ExecutionContextSetup.getAsLabels",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAsLabels",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"Labels"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.FakeRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FakeRequest",
|
|
"description": [
|
|
"\nFake request object created manually by Kibana plugins."
|
|
],
|
|
"signature": [
|
|
"FakeRequest"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.FakeRequest.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"Headers used for authentication against Elasticsearch"
|
|
],
|
|
"signature": [
|
|
"{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.GetDeprecationsContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetDeprecationsContext",
|
|
"description": [],
|
|
"path": "src/core/server/deprecations/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.GetDeprecationsContext.esClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "esClient",
|
|
"description": [],
|
|
"signature": [
|
|
"IScopedClusterClient"
|
|
],
|
|
"path": "src/core/server/deprecations/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.GetDeprecationsContext.savedObjectsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsClientContract"
|
|
],
|
|
"path": "src/core/server/deprecations/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpAuth",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpAuth",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpAuth"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpAuth.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => { status: ",
|
|
"AuthStatus",
|
|
"; state: T; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpAuth.get.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpAuth.isAuthenticated",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isAuthenticated",
|
|
"description": [
|
|
"\nReturns authentication status for a request.\n{@link IsAuthenticated}"
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpAuth.isAuthenticated.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResources",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpResources",
|
|
"description": [
|
|
"\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file."
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResources.register",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "register",
|
|
"description": [
|
|
"To register a route handler executing passed function to form response."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B, Context extends ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
">(route: ",
|
|
"RouteConfig",
|
|
"<P, Q, B, \"get\">, handler: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResourcesRequestHandler",
|
|
"text": "HttpResourcesRequestHandler"
|
|
},
|
|
"<P, Q, B, Context>) => void"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResources.register.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, \"get\">"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResources.register.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResourcesRequestHandler",
|
|
"text": "HttpResourcesRequestHandler"
|
|
},
|
|
"<P, Q, B, Context>"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesRenderOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpResourcesRenderOptions",
|
|
"description": [
|
|
"\nAllows to configure HTTP response parameters"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesRenderOptions.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"\nHTTP Headers with additional information about response."
|
|
],
|
|
"signature": [
|
|
"ResponseHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpResourcesServiceToolkit",
|
|
"description": [
|
|
"\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource."
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderCoreApp",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderCoreApp",
|
|
"description": [
|
|
"To respond with HTML page bootstrapping Kibana application."
|
|
],
|
|
"signature": [
|
|
"(options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResourcesRenderOptions",
|
|
"text": "HttpResourcesRenderOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderCoreApp.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResourcesRenderOptions",
|
|
"text": "HttpResourcesRenderOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderAnonymousCoreApp",
|
|
"description": [
|
|
"To respond with HTML page bootstrapping Kibana application without retrieving user-specific information."
|
|
],
|
|
"signature": [
|
|
"(options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResourcesRenderOptions",
|
|
"text": "HttpResourcesRenderOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResourcesRenderOptions",
|
|
"text": "HttpResourcesRenderOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderHtml",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderHtml",
|
|
"description": [
|
|
"To respond with a custom HTML page."
|
|
],
|
|
"signature": [
|
|
"(options: ",
|
|
"HttpResponseOptions",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any>"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderHtml.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpResponseOptions"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderJs",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderJs",
|
|
"description": [
|
|
"To respond with a custom JS script file."
|
|
],
|
|
"signature": [
|
|
"(options: ",
|
|
"HttpResponseOptions",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any>"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesServiceToolkit.renderJs.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpResponseOptions"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResponseOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpResponseOptions",
|
|
"description": [
|
|
"\nHTTP response parameters"
|
|
],
|
|
"signature": [
|
|
"HttpResponseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResponseOptions.body",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"HTTP message to send to the client"
|
|
],
|
|
"signature": [
|
|
"string | Record<string, any> | ",
|
|
"Stream",
|
|
" | Buffer | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResponseOptions.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"HTTP Headers with additional information about response"
|
|
],
|
|
"signature": [
|
|
"ResponseHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResponseOptions.bypassErrorFormat",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "bypassErrorFormat",
|
|
"description": [
|
|
"Bypass the default error formatting"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServerInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpServerInfo",
|
|
"description": [
|
|
"\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}."
|
|
],
|
|
"signature": [
|
|
"HttpServerInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServerInfo.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"The name of the Kibana server"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServerInfo.hostname",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "hostname",
|
|
"description": [
|
|
"The hostname of the server"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServerInfo.port",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "port",
|
|
"description": [
|
|
"The port the server is listening on"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServerInfo.protocol",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "protocol",
|
|
"description": [
|
|
"The protocol used by the server"
|
|
],
|
|
"signature": [
|
|
"\"http\" | \"https\" | \"socket\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServicePreboot",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpServicePreboot",
|
|
"description": [
|
|
"\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n"
|
|
],
|
|
"signature": [
|
|
"HttpServicePreboot",
|
|
"<DefaultRequestHandlerType>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServicePreboot.registerRoutes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerRoutes",
|
|
"description": [
|
|
"\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n"
|
|
],
|
|
"signature": [
|
|
"<ContextType extends DefaultRequestHandlerType = DefaultRequestHandlerType>(path: string, callback: (router: ",
|
|
"IRouter",
|
|
"<ContextType>) => void) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServicePreboot.registerRoutes.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServicePreboot.registerRoutes.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "callback",
|
|
"description": [],
|
|
"signature": [
|
|
"(router: ",
|
|
"IRouter",
|
|
"<ContextType>) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServicePreboot.basePath",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "basePath",
|
|
"description": [
|
|
"\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."
|
|
],
|
|
"signature": [
|
|
"IBasePath"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServicePreboot.getServerInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getServerInfo",
|
|
"description": [
|
|
"\nProvides common {@link HttpServerInfo | information} about the running preboot http server."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"HttpServerInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpServiceSetup",
|
|
"description": [
|
|
"\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n"
|
|
],
|
|
"signature": [
|
|
"HttpServiceSetup",
|
|
"<DefaultRequestHandlerType>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createCookieSessionStorageFactory",
|
|
"description": [
|
|
"\nCreates cookie based session storage factory {@link SessionStorageFactory}"
|
|
],
|
|
"signature": [
|
|
"<T>(cookieOptions: ",
|
|
"SessionStorageCookieOptions",
|
|
"<T>) => Promise<",
|
|
"SessionStorageFactory",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "cookieOptions",
|
|
"description": [
|
|
"{@link SessionStorageCookieOptions } - options to configure created cookie session storage."
|
|
],
|
|
"signature": [
|
|
"SessionStorageCookieOptions",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPreRouting",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerOnPreRouting",
|
|
"description": [
|
|
"\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n"
|
|
],
|
|
"signature": [
|
|
"(handler: ",
|
|
"OnPreRoutingHandler",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPreRouting.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link OnPreRoutingHandler } - function to call."
|
|
],
|
|
"signature": [
|
|
"OnPreRoutingHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPreAuth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerOnPreAuth",
|
|
"description": [
|
|
"\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n"
|
|
],
|
|
"signature": [
|
|
"(handler: ",
|
|
"OnPreAuthHandler",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPreAuth.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link OnPreRoutingHandler } - function to call."
|
|
],
|
|
"signature": [
|
|
"OnPreAuthHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerAuth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerAuth",
|
|
"description": [
|
|
"\nTo define custom authentication and/or authorization mechanism for incoming requests.\n"
|
|
],
|
|
"signature": [
|
|
"(handler: ",
|
|
"AuthenticationHandler",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerAuth.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link AuthenticationHandler } - function to perform authentication."
|
|
],
|
|
"signature": [
|
|
"AuthenticationHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPostAuth",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerOnPostAuth",
|
|
"description": [
|
|
"\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n"
|
|
],
|
|
"signature": [
|
|
"(handler: ",
|
|
"OnPostAuthHandler",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPostAuth.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link OnPostAuthHandler } - function to call."
|
|
],
|
|
"signature": [
|
|
"OnPostAuthHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPreResponse",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerOnPreResponse",
|
|
"description": [
|
|
"\nTo define custom logic to perform for the server response.\n"
|
|
],
|
|
"signature": [
|
|
"(handler: ",
|
|
"OnPreResponseHandler",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerOnPreResponse.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link OnPreResponseHandler } - function to call."
|
|
],
|
|
"signature": [
|
|
"OnPreResponseHandler"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.basePath",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "basePath",
|
|
"description": [
|
|
"\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."
|
|
],
|
|
"signature": [
|
|
"IBasePath"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.csp",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "csp",
|
|
"description": [
|
|
"\nThe CSP config used for Kibana."
|
|
],
|
|
"signature": [
|
|
"ICspConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.createRouter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createRouter",
|
|
"description": [
|
|
"\nProvides ability to declare a handler function for a particular path and HTTP request method.\n"
|
|
],
|
|
"signature": [
|
|
"<Context extends DefaultRequestHandlerType = DefaultRequestHandlerType>() => ",
|
|
"IRouter",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerRouteHandlerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerRouteHandlerContext",
|
|
"description": [
|
|
"\nRegister a context provider for a route handler."
|
|
],
|
|
"signature": [
|
|
"<Context extends DefaultRequestHandlerType, ContextName extends Exclude<keyof Context, \"resolve\">>(contextName: ContextName, provider: ",
|
|
"IContextProvider",
|
|
"<Context, ContextName>) => ",
|
|
"IContextContainer"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "contextName",
|
|
"description": [],
|
|
"signature": [
|
|
"ContextName"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "provider",
|
|
"description": [],
|
|
"signature": [
|
|
"IContextProvider",
|
|
"<Context, ContextName>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceSetup.getServerInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getServerInfo",
|
|
"description": [
|
|
"\nProvides common {@link HttpServerInfo | information} about the running http server."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"HttpServerInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HttpServiceStart",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpServiceStart"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceStart.basePath",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "basePath",
|
|
"description": [
|
|
"\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."
|
|
],
|
|
"signature": [
|
|
"IBasePath"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceStart.auth",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "auth",
|
|
"description": [
|
|
"\nAuth status.\nSee {@link HttpAuth}"
|
|
],
|
|
"signature": [
|
|
"HttpAuth"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpServiceStart.getServerInfo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getServerInfo",
|
|
"description": [
|
|
"\nProvides common {@link HttpServerInfo | information} about the running http server."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"HttpServerInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.I18nServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "I18nServiceSetup",
|
|
"description": [],
|
|
"path": "src/core/server/i18n/i18n_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.I18nServiceSetup.getLocale",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLocale",
|
|
"description": [
|
|
"\nReturn the locale currently in use."
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/core/server/i18n/i18n_service.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.I18nServiceSetup.getTranslationFiles",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTranslationFiles",
|
|
"description": [
|
|
"\nReturn the absolute paths to translation files currently in use."
|
|
],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "src/core/server/i18n/i18n_service.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IBasePath",
|
|
"description": [
|
|
"\nAccess or manipulate the Kibana base path\n"
|
|
],
|
|
"signature": [
|
|
"IBasePath"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.serverBasePath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "serverBasePath",
|
|
"description": [
|
|
"\nreturns the server's basePath.\n\nSee {@link IBasePath.get} for getting the basePath value for a specific request"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.publicBaseUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "publicBaseUrl",
|
|
"description": [
|
|
"\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nreturns `basePath` value, specific for an incoming request."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.get.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [
|
|
"\nsets `basePath` value, specific for an incoming request."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, requestSpecificBasePath: string) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.set.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.set.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "requestSpecificBasePath",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.prepend",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "prepend",
|
|
"description": [
|
|
"\nPrepends `path` with the basePath."
|
|
],
|
|
"signature": [
|
|
"(path: string) => string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.prepend.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.remove",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "remove",
|
|
"description": [
|
|
"\nRemoves the prepended basePath from the `path`."
|
|
],
|
|
"signature": [
|
|
"(path: string) => string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IBasePath.remove.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IClusterClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IClusterClient",
|
|
"description": [
|
|
"\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n"
|
|
],
|
|
"signature": [
|
|
"IClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IClusterClient.asInternalUser",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "asInternalUser",
|
|
"description": [
|
|
"\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user"
|
|
],
|
|
"signature": [
|
|
"{ name: string | symbol; transform: ",
|
|
"default",
|
|
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; }; cluster: ",
|
|
"default",
|
|
"; eql: ",
|
|
"default",
|
|
"; create: { <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; monitoring: ",
|
|
"default",
|
|
"; security: ",
|
|
"default",
|
|
"; index: { <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; get: { <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; }; delete: { (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
|
|
"default",
|
|
"; helpers: ",
|
|
"default",
|
|
"; child: (opts: ",
|
|
"ClientOptions",
|
|
") => ",
|
|
"default",
|
|
"; Internal: ",
|
|
"default",
|
|
"; asyncSearch: ",
|
|
"default",
|
|
"; autoscaling: ",
|
|
"default",
|
|
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>>; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; }; cat: ",
|
|
"default",
|
|
"; ccr: ",
|
|
"default",
|
|
"; clearScroll: { (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClearScrollResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; }; closePointInTime: { (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClosePointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; }; count: { (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"CountResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; }; danglingIndices: ",
|
|
"default",
|
|
"; deleteByQuery: { (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"DeleteByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; }; deleteByQueryRethrottle: { (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TasksTaskListResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; }; deleteScript: { (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; enrich: ",
|
|
"default",
|
|
"; exists: { (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; explain: { <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ExplainResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; }; features: ",
|
|
"default",
|
|
"; fieldCaps: { (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"FieldCapsResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; }; fleet: ",
|
|
"default",
|
|
"; getScript: { (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; }; getScriptContext: { (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptContextResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; }; getScriptLanguages: { (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptLanguagesResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; }; getSource: { <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<TDocument>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TDocument, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<TDocument>; }; graph: ",
|
|
"default",
|
|
"; ilm: ",
|
|
"default",
|
|
"; indices: ",
|
|
"default",
|
|
"; info: { (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"InfoResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; }; ingest: ",
|
|
"default",
|
|
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; }; license: ",
|
|
"default",
|
|
"; logstash: ",
|
|
"default",
|
|
"; mget: { <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MgetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; }; migration: ",
|
|
"default",
|
|
"; ml: ",
|
|
"default",
|
|
"; msearch: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; }; msearchTemplate: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; }; mtermvectors: { (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MtermvectorsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; }; nodes: ",
|
|
"default",
|
|
"; openPointInTime: { (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"OpenPointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; }; ping: { (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; rankEval: { (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RankEvalResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; }; reindex: { (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; }; reindexRethrottle: { (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; }; renderSearchTemplate: { (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RenderSearchTemplateResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; }; rollup: ",
|
|
"default",
|
|
"; scriptsPainlessExecute: { <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>, unknown>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; }; scroll: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; }; searchMvt: { (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<ArrayBuffer>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<ArrayBuffer, unknown>>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<ArrayBuffer>; }; searchShards: { (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchShardsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; }; searchTemplate: { <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; }; searchableSnapshots: ",
|
|
"default",
|
|
"; shutdown: ",
|
|
"default",
|
|
"; slm: ",
|
|
"default",
|
|
"; snapshot: ",
|
|
"default",
|
|
"; sql: ",
|
|
"default",
|
|
"; ssl: ",
|
|
"default",
|
|
"; tasks: ",
|
|
"default",
|
|
"; termsEnum: { (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermsEnumResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; }; termvectors: { <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermvectorsResponse",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; }; textStructure: ",
|
|
"default",
|
|
"; updateByQuery: { (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; }; updateByQueryRethrottle: { (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; }; watcher: ",
|
|
"default",
|
|
"; xpack: ",
|
|
"default",
|
|
"; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IClusterClient.asScoped",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asScoped",
|
|
"description": [
|
|
"\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}"
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"ScopeableRequest",
|
|
") => ",
|
|
"IScopedClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IClusterClient.asScoped.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"ScopeableRequest"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IContextContainer",
|
|
"description": [
|
|
"\nAn object that handles registration of context providers and configuring handlers with context.\n"
|
|
],
|
|
"signature": [
|
|
"IContextContainer"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer.registerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerContext",
|
|
"description": [
|
|
"\nRegister a new context provider.\n"
|
|
],
|
|
"signature": [
|
|
"<Context extends ",
|
|
"RequestHandlerContextBase",
|
|
", ContextName extends keyof Context>(pluginOpaqueId: symbol, contextName: ContextName, provider: ",
|
|
"IContextProvider",
|
|
"<Context, ContextName>) => this"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer.registerContext.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "pluginOpaqueId",
|
|
"description": [
|
|
"- The plugin opaque ID for the plugin that registers this context."
|
|
],
|
|
"signature": [
|
|
"symbol"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer.registerContext.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "contextName",
|
|
"description": [
|
|
"- The key of the `TContext` object this provider supplies the value for."
|
|
],
|
|
"signature": [
|
|
"ContextName"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer.registerContext.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "provider",
|
|
"description": [
|
|
"- A {@link IContextProvider } to be called each time a new context is created."
|
|
],
|
|
"signature": [
|
|
"IContextProvider",
|
|
"<Context, ContextName>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The {@link IContextContainer } for method chaining."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer.createHandler",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createHandler",
|
|
"description": [
|
|
"\nCreate a new handler function pre-wired to context for the plugin.\n"
|
|
],
|
|
"signature": [
|
|
"(pluginOpaqueId: symbol, handler: ",
|
|
"RequestHandler",
|
|
"<unknown, unknown, unknown, ",
|
|
"RequestHandlerContextBase",
|
|
", any, ",
|
|
"KibanaResponseFactory",
|
|
">) => (request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer.createHandler.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "pluginOpaqueId",
|
|
"description": [
|
|
"- The plugin opaque ID for the plugin that registers this handler."
|
|
],
|
|
"signature": [
|
|
"symbol"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextContainer.createHandler.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"- Handler function to pass context object to."
|
|
],
|
|
"signature": [
|
|
"RequestHandler",
|
|
"<unknown, unknown, unknown, ",
|
|
"RequestHandlerContextBase",
|
|
", any, ",
|
|
"KibanaResponseFactory",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value."
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ICspConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ICspConfig",
|
|
"description": [
|
|
"\nCSP configuration for use in Kibana."
|
|
],
|
|
"signature": [
|
|
"ICspConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ICspConfig.strict",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "strict",
|
|
"description": [
|
|
"\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ICspConfig.warnLegacyBrowsers",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "warnLegacyBrowsers",
|
|
"description": [
|
|
"\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ICspConfig.disableEmbedding",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "disableEmbedding",
|
|
"description": [
|
|
"\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ICspConfig.header",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "header",
|
|
"description": [
|
|
"\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ICustomClusterClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ICustomClusterClient",
|
|
"description": [
|
|
"\nSee {@link IClusterClient}\n"
|
|
],
|
|
"signature": [
|
|
"ICustomClusterClient",
|
|
" extends ",
|
|
"IClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ICustomClusterClient.close",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "close",
|
|
"description": [
|
|
"\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API."
|
|
],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IEventLoopDelaysMonitor",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IEventLoopDelaysMonitor",
|
|
"description": [
|
|
"\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays.\nSee {@link IntervalHistogram}"
|
|
],
|
|
"signature": [
|
|
"IEventLoopDelaysMonitor",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IEventLoopDelaysMonitor.collect",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "collect",
|
|
"description": [
|
|
"\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds.\n "
|
|
],
|
|
"signature": [
|
|
"() => T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IEventLoopDelaysMonitor.reset",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reset",
|
|
"description": [
|
|
"\nResets the collected histogram data."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IEventLoopDelaysMonitor.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [
|
|
"\nDisables updating the interval timer for collecting new data points."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExecutionContextContainer",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExecutionContextContainer",
|
|
"description": [],
|
|
"signature": [
|
|
"IExecutionContextContainer"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExecutionContextContainer.toString",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toString",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExecutionContextContainer.toJSON",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toJSON",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Readonly<",
|
|
"KibanaExecutionContext",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExternalUrlConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExternalUrlConfig",
|
|
"description": [
|
|
"\nExternal Url configuration for use in Kibana."
|
|
],
|
|
"signature": [
|
|
"IExternalUrlConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExternalUrlConfig.policy",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "policy",
|
|
"description": [
|
|
"\nA set of policies describing which external urls are allowed."
|
|
],
|
|
"signature": [
|
|
"IExternalUrlPolicy",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExternalUrlPolicy",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IExternalUrlPolicy",
|
|
"description": [
|
|
"\nA policy describing whether access to an external destination is allowed."
|
|
],
|
|
"signature": [
|
|
"IExternalUrlPolicy"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExternalUrlPolicy.allow",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allow",
|
|
"description": [
|
|
"\nIndicates if this policy allows or denies access to the described destination."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExternalUrlPolicy.host",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "host",
|
|
"description": [
|
|
"\nOptional host describing the external destination.\nMay be combined with `protocol`.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IExternalUrlPolicy.protocol",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "protocol",
|
|
"description": [
|
|
"\nOptional protocol describing the external destination.\nMay be combined with `host`.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IKibanaResponse",
|
|
"description": [
|
|
"\nA response data object, expected to returned as a result of {@link RequestHandler} execution"
|
|
],
|
|
"signature": [
|
|
"IKibanaResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaResponse.status",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "status",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaResponse.payload",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "payload",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaResponse.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"HttpResponseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IKibanaSocket",
|
|
"description": [
|
|
"\nA tiny abstraction for TCP socket."
|
|
],
|
|
"signature": [
|
|
"IKibanaSocket"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.getPeerCertificate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPeerCertificate",
|
|
"description": [],
|
|
"signature": [
|
|
"{ (detailed: true): ",
|
|
"DetailedPeerCertificate",
|
|
" | null; (detailed: false): ",
|
|
"PeerCertificate",
|
|
" | null; (detailed?: boolean | undefined): ",
|
|
"PeerCertificate",
|
|
" | ",
|
|
"DetailedPeerCertificate",
|
|
" | null; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.getPeerCertificate.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "detailed",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.getPeerCertificate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPeerCertificate",
|
|
"description": [],
|
|
"signature": [
|
|
"{ (detailed: true): ",
|
|
"DetailedPeerCertificate",
|
|
" | null; (detailed: false): ",
|
|
"PeerCertificate",
|
|
" | null; (detailed?: boolean | undefined): ",
|
|
"PeerCertificate",
|
|
" | ",
|
|
"DetailedPeerCertificate",
|
|
" | null; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.getPeerCertificate.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "detailed",
|
|
"description": [],
|
|
"signature": [
|
|
"false"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.getPeerCertificate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPeerCertificate",
|
|
"description": [
|
|
"\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null."
|
|
],
|
|
"signature": [
|
|
"{ (detailed: true): ",
|
|
"DetailedPeerCertificate",
|
|
" | null; (detailed: false): ",
|
|
"PeerCertificate",
|
|
" | null; (detailed?: boolean | undefined): ",
|
|
"PeerCertificate",
|
|
" | ",
|
|
"DetailedPeerCertificate",
|
|
" | null; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.getPeerCertificate.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "detailed",
|
|
"description": [
|
|
"- If true; the full chain with issuer property will be returned."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"An object representing the peer's certificate."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.getProtocol",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getProtocol",
|
|
"description": [
|
|
"\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information."
|
|
],
|
|
"signature": [
|
|
"() => string | null"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.renegotiate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renegotiate",
|
|
"description": [
|
|
"\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3."
|
|
],
|
|
"signature": [
|
|
"(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise<void>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.renegotiate.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.renegotiate.$1.rejectUnauthorized",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rejectUnauthorized",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.renegotiate.$1.requestCert",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requestCert",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.authorized",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "authorized",
|
|
"description": [
|
|
"\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IKibanaSocket.authorizationError",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "authorizationError",
|
|
"description": [
|
|
"\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`."
|
|
],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IntervalHistogram",
|
|
"description": [
|
|
"\nan IntervalHistogram object that samples and reports the event loop delay over time.\nThe delays will be reported in milliseconds.\n"
|
|
],
|
|
"signature": [
|
|
"IntervalHistogram"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.fromTimestamp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fromTimestamp",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.lastUpdatedAt",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "lastUpdatedAt",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.min",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "min",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.max",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "max",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.mean",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "mean",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.exceeds",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "exceeds",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.stddev",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "stddev",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IntervalHistogram.percentiles",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "percentiles",
|
|
"description": [],
|
|
"signature": [
|
|
"{ 50: number; 75: number; 95: number; 99: number; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRenderOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IRenderOptions",
|
|
"description": [],
|
|
"path": "src/core/server/rendering/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRenderOptions.isAnonymousPage",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isAnonymousPage",
|
|
"description": [
|
|
"\nSet whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata.\n`false` by default."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/core/server/rendering/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IRouter",
|
|
"description": [
|
|
"\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n"
|
|
],
|
|
"signature": [
|
|
"IRouter",
|
|
"<Context>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.routerPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "routerPath",
|
|
"description": [
|
|
"\nResulted path"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nRegister a route handler for `GET` request."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B>(route: ",
|
|
"RouteConfig",
|
|
"<P, Q, B, \"get\">, handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, \"get\", ",
|
|
"KibanaResponseFactory",
|
|
">) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.get.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [
|
|
"{@link RouteConfig } - a route configuration."
|
|
],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.get.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link RequestHandler } - a function to call to respond to an incoming request"
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.get.$2.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.get.$2.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.get.$2.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.post",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "post",
|
|
"description": [
|
|
"\nRegister a route handler for `POST` request."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B>(route: ",
|
|
"RouteConfig",
|
|
"<P, Q, B, \"post\">, handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, \"post\", ",
|
|
"KibanaResponseFactory",
|
|
">) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.post.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [
|
|
"{@link RouteConfig } - a route configuration."
|
|
],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.post.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link RequestHandler } - a function to call to respond to an incoming request"
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.post.$2.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.post.$2.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.post.$2.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.put",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "put",
|
|
"description": [
|
|
"\nRegister a route handler for `PUT` request."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B>(route: ",
|
|
"RouteConfig",
|
|
"<P, Q, B, \"put\">, handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, \"put\", ",
|
|
"KibanaResponseFactory",
|
|
">) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.put.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [
|
|
"{@link RouteConfig } - a route configuration."
|
|
],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.put.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link RequestHandler } - a function to call to respond to an incoming request"
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.put.$2.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.put.$2.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.put.$2.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.patch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "patch",
|
|
"description": [
|
|
"\nRegister a route handler for `PATCH` request."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B>(route: ",
|
|
"RouteConfig",
|
|
"<P, Q, B, \"patch\">, handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, \"patch\", ",
|
|
"KibanaResponseFactory",
|
|
">) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.patch.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [
|
|
"{@link RouteConfig } - a route configuration."
|
|
],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.patch.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link RequestHandler } - a function to call to respond to an incoming request"
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.patch.$2.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.patch.$2.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.patch.$2.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.delete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [
|
|
"\nRegister a route handler for `DELETE` request."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B>(route: ",
|
|
"RouteConfig",
|
|
"<P, Q, B, \"delete\">, handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, \"delete\", ",
|
|
"KibanaResponseFactory",
|
|
">) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.delete.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [
|
|
"{@link RouteConfig } - a route configuration."
|
|
],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.delete.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link RequestHandler } - a function to call to respond to an incoming request"
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.delete.$2.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.delete.$2.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.delete.$2.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.handleLegacyErrors",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handleLegacyErrors",
|
|
"description": [
|
|
"\nWrap a router handler to catch and converts legacy boom errors to proper custom errors."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B, Context extends ",
|
|
"RequestHandlerContextBase",
|
|
" = ",
|
|
"RequestHandlerContextBase",
|
|
", Method extends ",
|
|
"RouteMethod",
|
|
" = any, ResponseFactory extends ",
|
|
"KibanaResponseFactory",
|
|
" = ",
|
|
"KibanaResponseFactory",
|
|
">(handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, Method, ResponseFactory>) => ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, Method, ResponseFactory>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.handleLegacyErrors.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [
|
|
"{@link RequestHandler } - a route handler to wrap"
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ResponseFactory) => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.handleLegacyErrors.$1.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.handleLegacyErrors.$1.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IRouter.handleLegacyErrors.$1.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsPointInTimeFinder",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISavedObjectsPointInTimeFinder",
|
|
"description": [],
|
|
"signature": [
|
|
"ISavedObjectsPointInTimeFinder",
|
|
"<T, A>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsPointInTimeFinder.find",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "find",
|
|
"description": [
|
|
"\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size."
|
|
],
|
|
"signature": [
|
|
"() => AsyncGenerator<",
|
|
"SavedObjectsFindResponse",
|
|
"<T, A>, any, unknown>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsPointInTimeFinder.close",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "close",
|
|
"description": [
|
|
"\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason."
|
|
],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISavedObjectsRepository",
|
|
"description": [
|
|
"\nThe savedObjects repository contract.\n"
|
|
],
|
|
"signature": [
|
|
"ISavedObjectsRepository"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.create",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property"
|
|
],
|
|
"label": "create",
|
|
"description": [
|
|
"\nPersists an object\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, attributes: T, options?: ",
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.create.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.create.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.create.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { id, type, version, attributes }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkCreate",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"property"
|
|
],
|
|
"label": "bulkCreate",
|
|
"description": [
|
|
"\nCreates multiple documents at once\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkCreateObject",
|
|
"<T>[], options?: ",
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkCreate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- [{ type, id, attributes, references, migrationVersion }]"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkCreateObject",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkCreate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.checkConflicts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "checkConflicts",
|
|
"description": [
|
|
"\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten."
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectsCheckConflictsObject",
|
|
"[], options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsCheckConflictsResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.checkConflicts.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCheckConflictsObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.checkConflicts.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.delete",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property"
|
|
],
|
|
"label": "delete",
|
|
"description": [
|
|
"\nDeletes an object\n"
|
|
],
|
|
"signature": [
|
|
"(type: string, id: string, options?: ",
|
|
"SavedObjectsDeleteOptions",
|
|
" | undefined) => Promise<{}>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.delete.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.delete.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.delete.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsDeleteOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.deleteByNamespace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deleteByNamespace",
|
|
"description": [
|
|
"\nDeletes all objects from the provided namespace.\n"
|
|
],
|
|
"signature": [
|
|
"(namespace: string, options?: ",
|
|
"SavedObjectsDeleteByNamespaceOptions",
|
|
" | undefined) => Promise<any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.deleteByNamespace.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.deleteByNamespace.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsDeleteByNamespaceOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.find",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property",
|
|
"property"
|
|
],
|
|
"label": "find",
|
|
"description": [],
|
|
"signature": [
|
|
"<T = unknown, A = unknown>(options: ",
|
|
"SavedObjectsFindOptions",
|
|
") => Promise<",
|
|
"SavedObjectsFindResponse",
|
|
"<T, A>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.find.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsFindOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkGet",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property"
|
|
],
|
|
"label": "bulkGet",
|
|
"description": [
|
|
"\nReturns an array of objects by id\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkGetObject",
|
|
"[], options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkGet.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- an array of objects containing id, type and optionally fields"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkGetObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkGet.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { saved_objects: [{ id, type, version, attributes }] }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkResolve",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property"
|
|
],
|
|
"label": "bulkResolve",
|
|
"description": [
|
|
"\nResolves an array of objects by id, using any legacy URL aliases if they exist\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkResolveObject",
|
|
"[], options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkResolveResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkResolve.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- an array of objects containing id, type"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkResolveObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkResolve.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { resolved_objects: [{ saved_object, outcome }] }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.get",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property"
|
|
],
|
|
"label": "get",
|
|
"description": [
|
|
"\nGets a single object\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.get.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.get.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { id, type, version, attributes }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.resolve",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property"
|
|
],
|
|
"label": "resolve",
|
|
"description": [
|
|
"\nResolves a single object, using any legacy URL alias if it exists\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsResolveResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.resolve.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.resolve.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.resolve.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { saved_object, outcome }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.update",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"property",
|
|
"property"
|
|
],
|
|
"label": "update",
|
|
"description": [
|
|
"\nUpdates an object\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
"SavedObjectsUpdateOptions",
|
|
"<T> | undefined) => Promise<",
|
|
"SavedObjectsUpdateResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.update.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.update.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.update.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.update.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateOptions",
|
|
"<T> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "collectMultiNamespaceReferences",
|
|
"description": [
|
|
"\nGets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace\ntype.\n"
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"[], options?: ",
|
|
"SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"The objects to get the references for."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.updateObjectsSpaces",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateObjectsSpaces",
|
|
"description": [
|
|
"\nUpdates one or more objects to add and/or remove them from specified spaces.\n"
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectsUpdateObjectsSpacesObject",
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
"SavedObjectsUpdateObjectsSpacesOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsUpdateObjectsSpacesResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesToAdd",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesToRemove",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkUpdate",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"property"
|
|
],
|
|
"label": "bulkUpdate",
|
|
"description": [
|
|
"\nUpdates multiple objects in bulk\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<T>[], options?: ",
|
|
"SavedObjectsBulkUpdateOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkUpdateResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkUpdate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- [{ type, id, attributes, options: { version, namespace } references }]"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.bulkUpdate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.removeReferencesTo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeReferencesTo",
|
|
"description": [
|
|
"\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n"
|
|
],
|
|
"signature": [
|
|
"(type: string, id: string, options?: ",
|
|
"SavedObjectsRemoveReferencesToOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsRemoveReferencesToResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.removeReferencesTo.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.removeReferencesTo.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.removeReferencesTo.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsRemoveReferencesToOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.incrementCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "incrementCounter",
|
|
"description": [
|
|
"\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, counterFields: (string | ",
|
|
"SavedObjectsIncrementCounterField",
|
|
")[], options?: ",
|
|
"SavedObjectsIncrementCounterOptions",
|
|
"<T> | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.incrementCounter.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"- The type of saved object whose fields should be incremented"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.incrementCounter.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"- The id of the document whose fields should be incremented"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.incrementCounter.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "counterFields",
|
|
"description": [
|
|
"- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField }"
|
|
],
|
|
"signature": [
|
|
"(string | ",
|
|
"SavedObjectsIncrementCounterField",
|
|
")[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.incrementCounter.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- {@link SavedObjectsIncrementCounterOptions }"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsIncrementCounterOptions",
|
|
"<T> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"The saved object after the specified fields were incremented"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.openPointInTimeForType",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"property"
|
|
],
|
|
"label": "openPointInTimeForType",
|
|
"description": [
|
|
"\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n"
|
|
],
|
|
"signature": [
|
|
"(type: string | string[], options?: ",
|
|
"SavedObjectsOpenPointInTimeOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsOpenPointInTimeResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.openPointInTimeForType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.openPointInTimeForType.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- {@link SavedObjectsOpenPointInTimeOptions }"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsOpenPointInTimeOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- { id: string }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.closePointInTime",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "closePointInTime",
|
|
"description": [
|
|
"\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n"
|
|
],
|
|
"signature": [
|
|
"(id: string, options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsClosePointInTimeResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.closePointInTime.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.closePointInTime.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"- {@link SavedObjectsClosePointInTimeOptions }"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- {@link SavedObjectsClosePointInTimeResponse }"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.createPointInTimeFinder",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createPointInTimeFinder",
|
|
"description": [
|
|
"\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown, A = unknown>(findOptions: ",
|
|
"SavedObjectsCreatePointInTimeFinderOptions",
|
|
", dependencies?: ",
|
|
"SavedObjectsCreatePointInTimeFinderDependencies",
|
|
" | undefined) => ",
|
|
"ISavedObjectsPointInTimeFinder",
|
|
"<T, A>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.createPointInTimeFinder.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "findOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreatePointInTimeFinderOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ISavedObjectsRepository.createPointInTimeFinder.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dependencies",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreatePointInTimeFinderDependencies",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IScopedClusterClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IScopedClusterClient",
|
|
"description": [
|
|
"\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n"
|
|
],
|
|
"signature": [
|
|
"IScopedClusterClient"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IScopedClusterClient.asInternalUser",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "asInternalUser",
|
|
"description": [
|
|
"\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user."
|
|
],
|
|
"signature": [
|
|
"{ name: string | symbol; transform: ",
|
|
"default",
|
|
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; }; cluster: ",
|
|
"default",
|
|
"; eql: ",
|
|
"default",
|
|
"; create: { <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; monitoring: ",
|
|
"default",
|
|
"; security: ",
|
|
"default",
|
|
"; index: { <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; get: { <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; }; delete: { (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
|
|
"default",
|
|
"; helpers: ",
|
|
"default",
|
|
"; child: (opts: ",
|
|
"ClientOptions",
|
|
") => ",
|
|
"default",
|
|
"; Internal: ",
|
|
"default",
|
|
"; asyncSearch: ",
|
|
"default",
|
|
"; autoscaling: ",
|
|
"default",
|
|
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>>; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; }; cat: ",
|
|
"default",
|
|
"; ccr: ",
|
|
"default",
|
|
"; clearScroll: { (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClearScrollResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; }; closePointInTime: { (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClosePointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; }; count: { (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"CountResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; }; danglingIndices: ",
|
|
"default",
|
|
"; deleteByQuery: { (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"DeleteByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; }; deleteByQueryRethrottle: { (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TasksTaskListResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; }; deleteScript: { (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; enrich: ",
|
|
"default",
|
|
"; exists: { (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; explain: { <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ExplainResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; }; features: ",
|
|
"default",
|
|
"; fieldCaps: { (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"FieldCapsResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; }; fleet: ",
|
|
"default",
|
|
"; getScript: { (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; }; getScriptContext: { (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptContextResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; }; getScriptLanguages: { (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptLanguagesResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; }; getSource: { <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<TDocument>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TDocument, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<TDocument>; }; graph: ",
|
|
"default",
|
|
"; ilm: ",
|
|
"default",
|
|
"; indices: ",
|
|
"default",
|
|
"; info: { (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"InfoResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; }; ingest: ",
|
|
"default",
|
|
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; }; license: ",
|
|
"default",
|
|
"; logstash: ",
|
|
"default",
|
|
"; mget: { <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MgetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; }; migration: ",
|
|
"default",
|
|
"; ml: ",
|
|
"default",
|
|
"; msearch: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; }; msearchTemplate: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; }; mtermvectors: { (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MtermvectorsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; }; nodes: ",
|
|
"default",
|
|
"; openPointInTime: { (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"OpenPointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; }; ping: { (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; rankEval: { (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RankEvalResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; }; reindex: { (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; }; reindexRethrottle: { (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; }; renderSearchTemplate: { (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RenderSearchTemplateResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; }; rollup: ",
|
|
"default",
|
|
"; scriptsPainlessExecute: { <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>, unknown>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; }; scroll: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; }; searchMvt: { (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<ArrayBuffer>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<ArrayBuffer, unknown>>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<ArrayBuffer>; }; searchShards: { (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchShardsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; }; searchTemplate: { <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; }; searchableSnapshots: ",
|
|
"default",
|
|
"; shutdown: ",
|
|
"default",
|
|
"; slm: ",
|
|
"default",
|
|
"; snapshot: ",
|
|
"default",
|
|
"; sql: ",
|
|
"default",
|
|
"; ssl: ",
|
|
"default",
|
|
"; tasks: ",
|
|
"default",
|
|
"; termsEnum: { (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermsEnumResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; }; termvectors: { <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermvectorsResponse",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; }; textStructure: ",
|
|
"default",
|
|
"; updateByQuery: { (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; }; updateByQueryRethrottle: { (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; }; watcher: ",
|
|
"default",
|
|
"; xpack: ",
|
|
"default",
|
|
"; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IScopedClusterClient.asCurrentUser",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "asCurrentUser",
|
|
"description": [
|
|
"\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server."
|
|
],
|
|
"signature": [
|
|
"{ name: string | symbol; transform: ",
|
|
"default",
|
|
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; }; cluster: ",
|
|
"default",
|
|
"; eql: ",
|
|
"default",
|
|
"; create: { <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; monitoring: ",
|
|
"default",
|
|
"; security: ",
|
|
"default",
|
|
"; index: { <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; get: { <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; }; delete: { (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
|
|
"default",
|
|
"; helpers: ",
|
|
"default",
|
|
"; child: (opts: ",
|
|
"ClientOptions",
|
|
") => ",
|
|
"default",
|
|
"; Internal: ",
|
|
"default",
|
|
"; asyncSearch: ",
|
|
"default",
|
|
"; autoscaling: ",
|
|
"default",
|
|
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>>; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; }; cat: ",
|
|
"default",
|
|
"; ccr: ",
|
|
"default",
|
|
"; clearScroll: { (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClearScrollResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; }; closePointInTime: { (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClosePointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; }; count: { (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"CountResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; }; danglingIndices: ",
|
|
"default",
|
|
"; deleteByQuery: { (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"DeleteByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; }; deleteByQueryRethrottle: { (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TasksTaskListResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; }; deleteScript: { (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; enrich: ",
|
|
"default",
|
|
"; exists: { (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; explain: { <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ExplainResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; }; features: ",
|
|
"default",
|
|
"; fieldCaps: { (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"FieldCapsResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; }; fleet: ",
|
|
"default",
|
|
"; getScript: { (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; }; getScriptContext: { (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptContextResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; }; getScriptLanguages: { (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptLanguagesResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; }; getSource: { <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<TDocument>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TDocument, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<TDocument>; }; graph: ",
|
|
"default",
|
|
"; ilm: ",
|
|
"default",
|
|
"; indices: ",
|
|
"default",
|
|
"; info: { (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"InfoResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; }; ingest: ",
|
|
"default",
|
|
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; }; license: ",
|
|
"default",
|
|
"; logstash: ",
|
|
"default",
|
|
"; mget: { <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MgetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; }; migration: ",
|
|
"default",
|
|
"; ml: ",
|
|
"default",
|
|
"; msearch: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; }; msearchTemplate: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; }; mtermvectors: { (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MtermvectorsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; }; nodes: ",
|
|
"default",
|
|
"; openPointInTime: { (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"OpenPointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; }; ping: { (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; rankEval: { (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RankEvalResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; }; reindex: { (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; }; reindexRethrottle: { (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; }; renderSearchTemplate: { (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RenderSearchTemplateResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; }; rollup: ",
|
|
"default",
|
|
"; scriptsPainlessExecute: { <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>, unknown>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; }; scroll: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; }; searchMvt: { (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<ArrayBuffer>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<ArrayBuffer, unknown>>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<ArrayBuffer>; }; searchShards: { (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchShardsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; }; searchTemplate: { <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; }; searchableSnapshots: ",
|
|
"default",
|
|
"; shutdown: ",
|
|
"default",
|
|
"; slm: ",
|
|
"default",
|
|
"; snapshot: ",
|
|
"default",
|
|
"; sql: ",
|
|
"default",
|
|
"; ssl: ",
|
|
"default",
|
|
"; tasks: ",
|
|
"default",
|
|
"; termsEnum: { (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermsEnumResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; }; termvectors: { <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermvectorsResponse",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; }; textStructure: ",
|
|
"default",
|
|
"; updateByQuery: { (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; }; updateByQueryRethrottle: { (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; }; watcher: ",
|
|
"default",
|
|
"; xpack: ",
|
|
"default",
|
|
"; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IShipper",
|
|
"description": [
|
|
"\nBasic structure of a Shipper"
|
|
],
|
|
"signature": [
|
|
"IShipper"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.reportEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportEvents",
|
|
"description": [
|
|
"\nAdapts and ships the event to the persisting/analytics solution."
|
|
],
|
|
"signature": [
|
|
"(events: ",
|
|
"Event",
|
|
"[]) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.reportEvents.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "events",
|
|
"description": [
|
|
"batched events {@link Event }"
|
|
],
|
|
"signature": [
|
|
"Event",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.optIn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "optIn",
|
|
"description": [
|
|
"\nStops/restarts the shipping mechanism based on the value of isOptedIn"
|
|
],
|
|
"signature": [
|
|
"(isOptedIn: boolean) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.optIn.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isOptedIn",
|
|
"description": [
|
|
"`true` for resume sending events. `false` to stop."
|
|
],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.extendContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "extendContext",
|
|
"description": [
|
|
"\nPerform any necessary calls to the persisting/analytics solution to set the event's context."
|
|
],
|
|
"signature": [
|
|
"((newContext: ",
|
|
"EventContext",
|
|
") => void) | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.extendContext.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newContext",
|
|
"description": [
|
|
"The full new context to set {@link EventContext }"
|
|
],
|
|
"signature": [
|
|
"EventContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.telemetryCounter$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryCounter$",
|
|
"description": [
|
|
"\nObservable to emit the stats of the processed events."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
"> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IShipper.shutdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shutdown",
|
|
"description": [
|
|
"\nShutdown the shipper."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IUiSettingsClient",
|
|
"description": [
|
|
"\nServer-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.getRegistered",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRegistered",
|
|
"description": [
|
|
"\nReturns registered uiSettings values {@link UiSettingsParams}"
|
|
],
|
|
"signature": [
|
|
"() => Readonly<Record<string, ",
|
|
"PublicUiSettingsParams",
|
|
">>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nRetrieves uiSettings values set by the user with fallbacks to default values if not specified."
|
|
],
|
|
"signature": [
|
|
"<T = any>(key: string) => Promise<T>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.getAll",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAll",
|
|
"description": [
|
|
"\nRetrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified."
|
|
],
|
|
"signature": [
|
|
"<T = any>() => Promise<Record<string, T>>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.getUserProvided",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUserProvided",
|
|
"description": [
|
|
"\nRetrieves a set of all uiSettings values set by the user."
|
|
],
|
|
"signature": [
|
|
"<T = any>() => Promise<Record<string, ",
|
|
"UserProvidedValues",
|
|
"<T>>>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.setMany",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setMany",
|
|
"description": [
|
|
"\nWrites multiple uiSettings values and marks them as set by the user."
|
|
],
|
|
"signature": [
|
|
"(changes: Record<string, any>) => Promise<void>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.setMany.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "changes",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [
|
|
"\nWrites uiSettings value and marks it as set by the user."
|
|
],
|
|
"signature": [
|
|
"(key: string, value: any) => Promise<void>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.set.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.set.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.remove",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "remove",
|
|
"description": [
|
|
"\nRemoves uiSettings value by key."
|
|
],
|
|
"signature": [
|
|
"(key: string) => Promise<void>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.remove.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.removeMany",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeMany",
|
|
"description": [
|
|
"\nRemoves multiple uiSettings values by keys."
|
|
],
|
|
"signature": [
|
|
"(keys: string[]) => Promise<void>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.removeMany.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "keys",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.isOverridden",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isOverridden",
|
|
"description": [
|
|
"\nShows whether the uiSettings value set by the user."
|
|
],
|
|
"signature": [
|
|
"(key: string) => boolean"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.isOverridden.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.isSensitive",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isSensitive",
|
|
"description": [
|
|
"\nShows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values."
|
|
],
|
|
"signature": [
|
|
"(key: string) => boolean"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IUiSettingsClient.isSensitive.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "KibanaRequest",
|
|
"description": [
|
|
"\nKibana specific abstraction for an incoming request."
|
|
],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<Params, Query, Body, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nA identifier to identify this request.\n"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uuid",
|
|
"description": [
|
|
"\nA UUID to identify this request.\n"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.url",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "url",
|
|
"description": [
|
|
"a WHATWG URL standard object."
|
|
],
|
|
"signature": [
|
|
"URL"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.route",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [
|
|
"matched route details"
|
|
],
|
|
"signature": [
|
|
"{ readonly path: string; readonly method: ",
|
|
"RecursiveReadonly",
|
|
"<Method>; readonly options: ",
|
|
"RecursiveReadonly",
|
|
"<",
|
|
"KibanaRequestRouteOptions",
|
|
"<Method>>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"\nReadonly copy of incoming request headers."
|
|
],
|
|
"signature": [
|
|
"{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.isSystemRequest",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isSystemRequest",
|
|
"description": [
|
|
"\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.socket",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "socket",
|
|
"description": [
|
|
"\nThe socket associated with this request.\nSee {@link IKibanaSocket}."
|
|
],
|
|
"signature": [
|
|
"IKibanaSocket"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.events",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "events",
|
|
"description": [
|
|
"\nAllow to listen to events bound to this request.\nSee {@link KibanaRequestEvents}."
|
|
],
|
|
"signature": [
|
|
"KibanaRequestEvents"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.auth",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "auth",
|
|
"description": [
|
|
"\nThe auth status of this request.\nSee {@link KibanaRequestAuth}."
|
|
],
|
|
"signature": [
|
|
"KibanaRequestAuth"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.rewrittenUrl",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "rewrittenUrl",
|
|
"description": [
|
|
"\nURL rewritten in onPreRouting request interceptor."
|
|
],
|
|
"signature": [
|
|
"URL",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"\nThe path parameter of this request."
|
|
],
|
|
"signature": [
|
|
"Params"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.query",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [
|
|
"\nThe query parameter of this request."
|
|
],
|
|
"signature": [
|
|
"Query"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequest.body",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"\nThe body payload of this request."
|
|
],
|
|
"signature": [
|
|
"Body"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestEvents",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "KibanaRequestEvents",
|
|
"description": [
|
|
"\nRequest events."
|
|
],
|
|
"signature": [
|
|
"KibanaRequestEvents"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestEvents.aborted$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aborted$",
|
|
"description": [
|
|
"\nObservable that emits once if and when the request has been aborted."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<void>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestEvents.completed$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "completed$",
|
|
"description": [
|
|
"\nObservable that emits once if and when the request has been completely handled.\n"
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<void>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestRoute",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "KibanaRequestRoute",
|
|
"description": [
|
|
"\nRequest specific route information exposed to a handler."
|
|
],
|
|
"signature": [
|
|
"KibanaRequestRoute",
|
|
"<Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestRoute.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestRoute.method",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "method",
|
|
"description": [],
|
|
"signature": [
|
|
"Method"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestRoute.options",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"Method extends \"options\" | \"get\" ? Required<Omit<",
|
|
"RouteConfigOptions",
|
|
"<Method>, \"body\">> : Required<",
|
|
"RouteConfigOptions",
|
|
"<Method>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Logger",
|
|
"description": [
|
|
"\nLogger exposes all the necessary methods to log any type of information and\nthis is the interface used by the logging consumers including plugins.\n"
|
|
],
|
|
"signature": [
|
|
"Logger"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.trace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "trace",
|
|
"description": [
|
|
"\nLog messages at the most detailed log level\n"
|
|
],
|
|
"signature": [
|
|
"<Meta extends ",
|
|
"LogMeta",
|
|
" = ",
|
|
"LogMeta",
|
|
">(message: string, meta?: Meta | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.trace.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"- The log message"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.trace.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"-"
|
|
],
|
|
"signature": [
|
|
"Meta | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.debug",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "debug",
|
|
"description": [
|
|
"\nLog messages useful for debugging and interactive investigation"
|
|
],
|
|
"signature": [
|
|
"<Meta extends ",
|
|
"LogMeta",
|
|
" = ",
|
|
"LogMeta",
|
|
">(message: string, meta?: Meta | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.debug.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"- The log message"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.debug.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"-"
|
|
],
|
|
"signature": [
|
|
"Meta | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.info",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "info",
|
|
"description": [
|
|
"\nLogs messages related to general application flow"
|
|
],
|
|
"signature": [
|
|
"<Meta extends ",
|
|
"LogMeta",
|
|
" = ",
|
|
"LogMeta",
|
|
">(message: string, meta?: Meta | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.info.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"- The log message"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.info.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"-"
|
|
],
|
|
"signature": [
|
|
"Meta | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.warn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "warn",
|
|
"description": [
|
|
"\nLogs abnormal or unexpected errors or messages"
|
|
],
|
|
"signature": [
|
|
"<Meta extends ",
|
|
"LogMeta",
|
|
" = ",
|
|
"LogMeta",
|
|
">(errorOrMessage: string | Error, meta?: Meta | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.warn.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "errorOrMessage",
|
|
"description": [
|
|
"- An Error object or message string to log"
|
|
],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.warn.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"-"
|
|
],
|
|
"signature": [
|
|
"Meta | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.error",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"\nLogs abnormal or unexpected errors or messages that caused a failure in the application flow\n"
|
|
],
|
|
"signature": [
|
|
"<Meta extends ",
|
|
"LogMeta",
|
|
" = ",
|
|
"LogMeta",
|
|
">(errorOrMessage: string | Error, meta?: Meta | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.error.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "errorOrMessage",
|
|
"description": [
|
|
"- An Error object or message string to log"
|
|
],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.error.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"-"
|
|
],
|
|
"signature": [
|
|
"Meta | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.fatal",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fatal",
|
|
"description": [
|
|
"\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n"
|
|
],
|
|
"signature": [
|
|
"<Meta extends ",
|
|
"LogMeta",
|
|
" = ",
|
|
"LogMeta",
|
|
">(errorOrMessage: string | Error, meta?: Meta | undefined) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.fatal.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "errorOrMessage",
|
|
"description": [
|
|
"- An Error object or message string to log"
|
|
],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.fatal.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"-"
|
|
],
|
|
"signature": [
|
|
"Meta | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nReturns a new {@link Logger} instance extending the current logger context.\n"
|
|
],
|
|
"signature": [
|
|
"(...childContextPaths: string[]) => ",
|
|
"Logger"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Logger.get.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "childContextPaths",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerConfigType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LoggerConfigType",
|
|
"description": [
|
|
"\nDescribes the configuration of a given logger.\n"
|
|
],
|
|
"signature": [
|
|
"LoggerConfigType"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerConfigType.appenders",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "appenders",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerConfigType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerConfigType.level",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "level",
|
|
"description": [],
|
|
"signature": [
|
|
"\"error\" | \"all\" | \"off\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerContextConfigInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LoggerContextConfigInput",
|
|
"description": [
|
|
"\nInput used to configure logging dynamically using {@link LoggingServiceSetup.configure}"
|
|
],
|
|
"signature": [
|
|
"LoggerContextConfigInput"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerContextConfigInput.appenders",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "appenders",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"AppenderConfigType",
|
|
"> | Map<string, ",
|
|
"AppenderConfigType",
|
|
"> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerContextConfigInput.loggers",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "loggers",
|
|
"description": [],
|
|
"signature": [
|
|
"LoggerConfigType",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerFactory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LoggerFactory",
|
|
"description": [
|
|
"\nThe single purpose of `LoggerFactory` interface is to define a way to\nretrieve a context-based logger instance.\n"
|
|
],
|
|
"signature": [
|
|
"LoggerFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerFactory.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nReturns a `Logger` instance for the specified context.\n"
|
|
],
|
|
"signature": [
|
|
"(...contextParts: string[]) => ",
|
|
"Logger"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggerFactory.get.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "contextParts",
|
|
"description": [
|
|
"- Parts of the context to return logger for. For example\nget('plugins', 'pid') will return a logger for the `plugins.pid` context."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggingServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LoggingServiceSetup",
|
|
"description": [
|
|
"\nProvides APIs to plugins for customizing the plugin's logger."
|
|
],
|
|
"signature": [
|
|
"LoggingServiceSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggingServiceSetup.configure",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "configure",
|
|
"description": [
|
|
"\nCustomizes the logging config for the plugin's context.\n"
|
|
],
|
|
"signature": [
|
|
"(config$: ",
|
|
"Observable",
|
|
"<",
|
|
"LoggerContextConfigInput",
|
|
">) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LoggingServiceSetup.configure.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"LoggerContextConfigInput",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.MetricsServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MetricsServiceSetup",
|
|
"description": [
|
|
"\nAPIs to retrieves metrics gathered and exposed by the core platform.\n"
|
|
],
|
|
"signature": [
|
|
"MetricsServiceSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.MetricsServiceSetup.collectionInterval",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "collectionInterval",
|
|
"description": [
|
|
"Interval metrics are collected in milliseconds"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.MetricsServiceSetup.getOpsMetrics$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOpsMetrics$",
|
|
"description": [
|
|
"\nRetrieve an observable emitting the {@link OpsMetrics} gathered.\nThe observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time,\nbased on the `opts.interval` configuration property.\n"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<",
|
|
"OpsMetrics",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodeInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NodeInfo",
|
|
"description": [
|
|
"\nContains information about how this Kibana process has been configured.\n"
|
|
],
|
|
"signature": [
|
|
"NodeInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodeInfo.roles",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "roles",
|
|
"description": [
|
|
"A list of roles this node has been configured with."
|
|
],
|
|
"signature": [
|
|
"NodeRoles"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodeRoles",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NodeRoles",
|
|
"description": [
|
|
"\nThe Kibana process can be run in dedicated \"modes\" via `node.roles`.\nThis configuration is then exposed to plugins via `NodeRoles`,\nwhich is available on the `PluginInitializerContext`.\n\nThe node roles can be used by plugins to adjust their behavior based\non the way the Kibana process has been configured.\n"
|
|
],
|
|
"signature": [
|
|
"NodeRoles"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodeRoles.backgroundTasks",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "backgroundTasks",
|
|
"description": [
|
|
"\nThe backgroundTasks role includes operations which don't involve\nresponding to incoming http traffic from the UI."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodeRoles.ui",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "ui",
|
|
"description": [
|
|
"\nThe ui role covers any operations that need to occur in order\nto handle http traffic from the browser."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodesVersionCompatibility",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "NodesVersionCompatibility",
|
|
"description": [],
|
|
"signature": [
|
|
"NodesVersionCompatibility"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodesVersionCompatibility.isCompatible",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isCompatible",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodesVersionCompatibility.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodesVersionCompatibility.incompatibleNodes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "incompatibleNodes",
|
|
"description": [],
|
|
"signature": [
|
|
"NodeInfo",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodesVersionCompatibility.warningNodes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "warningNodes",
|
|
"description": [],
|
|
"signature": [
|
|
"NodeInfo",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodesVersionCompatibility.kibanaVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaVersion",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.NodesVersionCompatibility.nodesInfoRequestError",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "nodesInfoRequestError",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPostAuthToolkit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OnPostAuthToolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPostAuthToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPostAuthToolkit.next",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "next",
|
|
"description": [
|
|
"To pass request to the next handler"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"OnPostAuthNextResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreAuthToolkit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OnPreAuthToolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreAuthToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreAuthToolkit.next",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "next",
|
|
"description": [
|
|
"To pass request to the next handler"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"OnPreAuthNextResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseExtensions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OnPreResponseExtensions",
|
|
"description": [
|
|
"\nAdditional data to extend a response."
|
|
],
|
|
"signature": [
|
|
"OnPreResponseExtensions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseExtensions.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"additional headers to attach to the response"
|
|
],
|
|
"signature": [
|
|
"ResponseHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OnPreResponseInfo",
|
|
"description": [
|
|
"\nResponse status code."
|
|
],
|
|
"signature": [
|
|
"OnPreResponseInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseInfo.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseRender",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OnPreResponseRender",
|
|
"description": [
|
|
"\nAdditional data to extend a response when rendering a new body"
|
|
],
|
|
"signature": [
|
|
"OnPreResponseRender"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseRender.headers",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "headers",
|
|
"description": [
|
|
"additional headers to attach to the response"
|
|
],
|
|
"signature": [
|
|
"ResponseHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseRender.body",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"the body to use in the response"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseToolkit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OnPreResponseToolkit",
|
|
"description": [
|
|
"\nA tool set defining an outcome of OnPreResponse interceptor for incoming request."
|
|
],
|
|
"signature": [
|
|
"OnPreResponseToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseToolkit.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [
|
|
"To override the response with a different body"
|
|
],
|
|
"signature": [
|
|
"(responseRender: ",
|
|
"OnPreResponseRender",
|
|
") => ",
|
|
"OnPreResponseResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseToolkit.render.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "responseRender",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreResponseRender"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseToolkit.next",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "next",
|
|
"description": [
|
|
"To pass request to the next handler"
|
|
],
|
|
"signature": [
|
|
"(responseExtensions?: ",
|
|
"OnPreResponseExtensions",
|
|
" | undefined) => ",
|
|
"OnPreResponseResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseToolkit.next.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "responseExtensions",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreResponseExtensions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingToolkit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OnPreRoutingToolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreRoutingToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingToolkit.next",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "next",
|
|
"description": [
|
|
"To pass request to the next handler"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"OnPreRoutingResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingToolkit.rewriteUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "rewriteUrl",
|
|
"description": [
|
|
"Rewrite requested resources url before is was authenticated and routed to a handler"
|
|
],
|
|
"signature": [
|
|
"(url: string) => ",
|
|
"OnPreRoutingResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingToolkit.rewriteUrl.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "url",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OpsMetrics",
|
|
"description": [
|
|
"\nRegroups metrics gathered by all the collectors.\nThis contains metrics about the os/runtime, the kibana process and the http server.\n"
|
|
],
|
|
"signature": [
|
|
"OpsMetrics"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics.collected_at",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "collected_at",
|
|
"description": [
|
|
"Time metrics were recorded at."
|
|
],
|
|
"signature": [
|
|
"Date"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics.process",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "process",
|
|
"description": [
|
|
"\nProcess related metrics."
|
|
],
|
|
"signature": [
|
|
"OpsProcessMetrics"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": true,
|
|
"removeBy": "8.8.0",
|
|
"references": [
|
|
{
|
|
"plugin": "monitoring",
|
|
"path": "x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts"
|
|
},
|
|
{
|
|
"plugin": "kibanaUsageCollection",
|
|
"path": "src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-metrics-server-internal",
|
|
"path": "packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-metrics-server-internal",
|
|
"path": "packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts"
|
|
},
|
|
{
|
|
"plugin": "@kbn/core-metrics-server-internal",
|
|
"path": "packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics.processes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "processes",
|
|
"description": [
|
|
"Process related metrics. Reports an array of objects for each kibana pid."
|
|
],
|
|
"signature": [
|
|
"OpsProcessMetrics",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics.os",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "os",
|
|
"description": [
|
|
"OS related metrics"
|
|
],
|
|
"signature": [
|
|
"OpsOsMetrics"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics.response_times",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response_times",
|
|
"description": [
|
|
"server response time stats"
|
|
],
|
|
"signature": [
|
|
"{ avg_in_millis: number; max_in_millis: number; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics.requests",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requests",
|
|
"description": [
|
|
"server requests stats"
|
|
],
|
|
"signature": [
|
|
"{ disconnects: number; total: number; statusCodes: Record<number, number>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsMetrics.concurrent_connections",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "concurrent_connections",
|
|
"description": [
|
|
"number of current concurrent connections to the server"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OpsOsMetrics",
|
|
"description": [
|
|
"\nOS related metrics"
|
|
],
|
|
"signature": [
|
|
"OpsOsMetrics"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.platform",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "platform",
|
|
"description": [
|
|
"The os platform"
|
|
],
|
|
"signature": [
|
|
"\"linux\" | \"aix\" | \"android\" | \"darwin\" | \"freebsd\" | \"haiku\" | \"openbsd\" | \"sunos\" | \"win32\" | \"cygwin\" | \"netbsd\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.platformRelease",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "platformRelease",
|
|
"description": [
|
|
"The os platform release, prefixed by the platform name"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.distro",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "distro",
|
|
"description": [
|
|
"The os distrib. Only present for linux platforms"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.distroRelease",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "distroRelease",
|
|
"description": [
|
|
"The os distrib release, prefixed by the os distrib. Only present for linux platforms"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.load",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "load",
|
|
"description": [
|
|
"cpu load metrics"
|
|
],
|
|
"signature": [
|
|
"{ '1m': number; '5m': number; '15m': number; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.memory",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "memory",
|
|
"description": [
|
|
"system memory usage metrics"
|
|
],
|
|
"signature": [
|
|
"{ total_in_bytes: number; free_in_bytes: number; used_in_bytes: number; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.uptime_in_millis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "uptime_in_millis",
|
|
"description": [
|
|
"the OS uptime"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.cpuacct",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "cpuacct",
|
|
"description": [
|
|
"cpu accounting metrics, undefined when not running in a cgroup"
|
|
],
|
|
"signature": [
|
|
"{ control_group: string; usage_nanos: number; } | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsOsMetrics.cpu",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "cpu",
|
|
"description": [
|
|
"cpu cgroup metrics, undefined when not running in a cgroup"
|
|
],
|
|
"signature": [
|
|
"{ control_group: string; cfs_period_micros: number; cfs_quota_micros: number; stat: { number_of_elapsed_periods: number; number_of_times_throttled: number; time_throttled_nanos: number; }; } | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsProcessMetrics",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OpsProcessMetrics",
|
|
"description": [
|
|
"\nProcess related metrics"
|
|
],
|
|
"signature": [
|
|
"OpsProcessMetrics"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsProcessMetrics.pid",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "pid",
|
|
"description": [
|
|
"pid of the kibana process"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsProcessMetrics.memory",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "memory",
|
|
"description": [
|
|
"process memory usage"
|
|
],
|
|
"signature": [
|
|
"{ heap: { total_in_bytes: number; used_in_bytes: number; size_limit: number; }; resident_set_size_in_bytes: number; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsProcessMetrics.event_loop_delay",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "event_loop_delay",
|
|
"description": [
|
|
"mean event loop delay since last collection"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsProcessMetrics.event_loop_delay_histogram",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "event_loop_delay_histogram",
|
|
"description": [
|
|
"node event loop delay histogram since last collection"
|
|
],
|
|
"signature": [
|
|
"IntervalHistogram"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsProcessMetrics.uptime_in_millis",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "uptime_in_millis",
|
|
"description": [
|
|
"uptime of the kibana process"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsServerMetrics",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OpsServerMetrics",
|
|
"description": [
|
|
"\nserver related metrics"
|
|
],
|
|
"signature": [
|
|
"OpsServerMetrics"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsServerMetrics.response_times",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "response_times",
|
|
"description": [
|
|
"server response time stats"
|
|
],
|
|
"signature": [
|
|
"{ avg_in_millis: number; max_in_millis: number; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsServerMetrics.requests",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requests",
|
|
"description": [
|
|
"server requests stats"
|
|
],
|
|
"signature": [
|
|
"{ disconnects: number; total: number; statusCodes: Record<number, number>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OpsServerMetrics.concurrent_connections",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "concurrent_connections",
|
|
"description": [
|
|
"number of current concurrent connections to the server"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OptInConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OptInConfig",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"OptInConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OptInConfig.global",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "global",
|
|
"description": [
|
|
"\nControls the global enabled/disabled behaviour of the client and shippers."
|
|
],
|
|
"signature": [
|
|
"OptInConfigPerType"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OptInConfig.event_types",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "event_types",
|
|
"description": [
|
|
"\nControls if an event type should be disabled for a specific type of shipper."
|
|
],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"OptInConfigPerType",
|
|
" | undefined> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PackageInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PackageInfo",
|
|
"description": [],
|
|
"signature": [
|
|
"PackageInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PackageInfo.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PackageInfo.branch",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "branch",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PackageInfo.buildNum",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "buildNum",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PackageInfo.buildSha",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buildSha",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PackageInfo.dist",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "dist",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Plugin",
|
|
"description": [
|
|
"\nThe interface that should be returned by a `PluginInitializer` for a `standard` plugin.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<TSetup, TStart, TPluginsSetup, TPluginsStart>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, plugins: TPluginsSetup) => TSetup"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin.setup.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
"TPluginsSetup"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", plugins: TPluginsStart) => TStart"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin.start.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin.start.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
"TPluginsStart"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Plugin.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginConfigDescriptor",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginConfigDescriptor",
|
|
"description": [
|
|
"\nDescribes a plugin configuration properties.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginConfigDescriptor",
|
|
"text": "PluginConfigDescriptor"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginConfigDescriptor.deprecations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deprecations",
|
|
"description": [
|
|
"\nProvider for the {@link ConfigDeprecation} to apply to the plugin configuration."
|
|
],
|
|
"signature": [
|
|
"ConfigDeprecationProvider",
|
|
" | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginConfigDescriptor.exposeToBrowser",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "exposeToBrowser",
|
|
"description": [
|
|
"\nList of configuration properties that will be available on the client-side plugin."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ExposedToBrowserDescriptor",
|
|
"text": "ExposedToBrowserDescriptor"
|
|
},
|
|
"<T> | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginConfigDescriptor.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [
|
|
"\nSchema to use to validate the plugin configuration.\n\n{@link PluginConfigSchema}"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<T>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginConfigDescriptor.exposeToUsage",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "exposeToUsage",
|
|
"description": [
|
|
"\nExpose non-default configs to usage collection to be sent via telemetry.\nset a config to `true` to report the actual changed config value.\nset a config to `false` to report the changed config value as [redacted].\n\nAll changed configs except booleans and numbers will be reported\nas [redacted] unless otherwise specified.\n\n{@link MakeUsageFromSchema}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.MakeUsageFromSchema",
|
|
"text": "MakeUsageFromSchema"
|
|
},
|
|
"<T> | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginInitializerContext",
|
|
"description": [
|
|
"\nContext that's available to plugins during initialization stage.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<ConfigSchema>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializerContext.opaqueId",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "opaqueId",
|
|
"description": [],
|
|
"signature": [
|
|
"symbol"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializerContext.env",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "env",
|
|
"description": [],
|
|
"signature": [
|
|
"{ mode: ",
|
|
"EnvironmentMode",
|
|
"; packageInfo: Readonly<",
|
|
"PackageInfo",
|
|
">; instanceUuid: string; configs: readonly string[]; }"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializerContext.node",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "node",
|
|
"description": [
|
|
"\nAccess the configuration for this particular Kibana node.\nCan be used to determine which `roles` the current process was started with.\n"
|
|
],
|
|
"signature": [
|
|
"NodeInfo"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializerContext.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [
|
|
"\n{@link LoggerFactory | logger factory} instance already bound to the plugin's logging context\n"
|
|
],
|
|
"signature": [
|
|
"LoggerFactory"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializerContext.config",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [
|
|
"\nAccessors for the plugin's configuration"
|
|
],
|
|
"signature": [
|
|
"{ legacy: { globalConfig$: ",
|
|
"Observable",
|
|
"<Readonly<{ 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: ByteSizeValueUnit | undefined) => string; }>; }>; }>>; get: () => Readonly<{ 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: ByteSizeValueUnit | undefined) => string; }>; }>; }>; }; create: <T = ConfigSchema>() => ",
|
|
"Observable",
|
|
"<T>; get: <T = ConfigSchema>() => T; }"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PluginManifest",
|
|
"description": [
|
|
"\nDescribes the set of required and optional properties plugin can define in its\nmandatory JSON manifest file.\n"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nIdentifier of the plugin. Must be a string in camelCase. Part of a plugin public contract.\nOther plugins leverage it to access plugin API, navigate to the plugin, etc."
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nVersion of the plugin."
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.kibanaVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaVersion",
|
|
"description": [
|
|
"\nThe version of Kibana the plugin is compatible with, defaults to \"version\"."
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.type",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nType of the plugin, defaults to `standard`."
|
|
],
|
|
"signature": [
|
|
"PluginType"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.configPath",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "configPath",
|
|
"description": [
|
|
"\nRoot {@link ConfigPath | configuration path} used by the plugin, defaults\nto \"id\" in snake_case format.\n"
|
|
],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.requiredPlugins",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requiredPlugins",
|
|
"description": [
|
|
"\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly."
|
|
],
|
|
"signature": [
|
|
"readonly string[]"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.requiredBundles",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requiredBundles",
|
|
"description": [
|
|
"\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n"
|
|
],
|
|
"signature": [
|
|
"readonly string[]"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.optionalPlugins",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "optionalPlugins",
|
|
"description": [
|
|
"\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly."
|
|
],
|
|
"signature": [
|
|
"readonly string[]"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.ui",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "ui",
|
|
"description": [
|
|
"\nSpecifies whether plugin includes some client/browser specific functionality\nthat should be included into client bundle via `public/ui_plugin.js` file."
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.server",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "server",
|
|
"description": [
|
|
"\nSpecifies whether plugin includes some server-side specific functionality."
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.extraPublicDirs",
|
|
"type": "Array",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "extraPublicDirs",
|
|
"description": [
|
|
"\nSpecifies directory names that can be imported by other ui-plugins built\nusing the same instance of the @kbn/optimizer. A temporary measure we plan\nto replace with better mechanisms for sharing static code between plugins"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": true,
|
|
"references": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.serviceFolders",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "serviceFolders",
|
|
"description": [
|
|
"\nOnly used for the automatically generated API documentation. Specifying service\nfolders will cause your plugin API reference to be broken up into sub sections."
|
|
],
|
|
"signature": [
|
|
"readonly string[] | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.owner",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "owner",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly name: string; readonly githubTeam?: string | undefined; }"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nTODO: make required once all plugins specify this.\nA brief description of what this plugin does and any capabilities it provides."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginManifest.enabledOnAnonymousPages",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "enabledOnAnonymousPages",
|
|
"description": [
|
|
"\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PollEsNodesVersionOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PollEsNodesVersionOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"PollEsNodesVersionOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PollEsNodesVersionOptions.internalClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "internalClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string | symbol; transform: ",
|
|
"default",
|
|
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; }; cluster: ",
|
|
"default",
|
|
"; eql: ",
|
|
"default",
|
|
"; create: { <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; monitoring: ",
|
|
"default",
|
|
"; security: ",
|
|
"default",
|
|
"; index: { <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; get: { <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; }; delete: { (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
|
|
"default",
|
|
"; helpers: ",
|
|
"default",
|
|
"; child: (opts: ",
|
|
"ClientOptions",
|
|
") => ",
|
|
"default",
|
|
"; Internal: ",
|
|
"default",
|
|
"; asyncSearch: ",
|
|
"default",
|
|
"; autoscaling: ",
|
|
"default",
|
|
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>>; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; }; cat: ",
|
|
"default",
|
|
"; ccr: ",
|
|
"default",
|
|
"; clearScroll: { (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClearScrollResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; }; closePointInTime: { (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClosePointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; }; count: { (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"CountResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; }; danglingIndices: ",
|
|
"default",
|
|
"; deleteByQuery: { (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"DeleteByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; }; deleteByQueryRethrottle: { (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TasksTaskListResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; }; deleteScript: { (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; enrich: ",
|
|
"default",
|
|
"; exists: { (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; explain: { <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ExplainResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; }; features: ",
|
|
"default",
|
|
"; fieldCaps: { (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"FieldCapsResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; }; fleet: ",
|
|
"default",
|
|
"; getScript: { (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; }; getScriptContext: { (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptContextResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; }; getScriptLanguages: { (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptLanguagesResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; }; getSource: { <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<TDocument>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TDocument, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<TDocument>; }; graph: ",
|
|
"default",
|
|
"; ilm: ",
|
|
"default",
|
|
"; indices: ",
|
|
"default",
|
|
"; info: { (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"InfoResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; }; ingest: ",
|
|
"default",
|
|
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; }; license: ",
|
|
"default",
|
|
"; logstash: ",
|
|
"default",
|
|
"; mget: { <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MgetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; }; migration: ",
|
|
"default",
|
|
"; ml: ",
|
|
"default",
|
|
"; msearch: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; }; msearchTemplate: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; }; mtermvectors: { (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MtermvectorsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; }; nodes: ",
|
|
"default",
|
|
"; openPointInTime: { (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"OpenPointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; }; ping: { (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; rankEval: { (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RankEvalResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; }; reindex: { (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; }; reindexRethrottle: { (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; }; renderSearchTemplate: { (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RenderSearchTemplateResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; }; rollup: ",
|
|
"default",
|
|
"; scriptsPainlessExecute: { <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>, unknown>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; }; scroll: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; }; searchMvt: { (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<ArrayBuffer>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<ArrayBuffer, unknown>>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<ArrayBuffer>; }; searchShards: { (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchShardsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; }; searchTemplate: { <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; }; searchableSnapshots: ",
|
|
"default",
|
|
"; shutdown: ",
|
|
"default",
|
|
"; slm: ",
|
|
"default",
|
|
"; snapshot: ",
|
|
"default",
|
|
"; sql: ",
|
|
"default",
|
|
"; ssl: ",
|
|
"default",
|
|
"; tasks: ",
|
|
"default",
|
|
"; termsEnum: { (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermsEnumResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; }; termvectors: { <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermvectorsResponse",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; }; textStructure: ",
|
|
"default",
|
|
"; updateByQuery: { (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; }; updateByQueryRethrottle: { (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; }; watcher: ",
|
|
"default",
|
|
"; xpack: ",
|
|
"default",
|
|
"; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PollEsNodesVersionOptions.log",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "log",
|
|
"description": [],
|
|
"signature": [
|
|
"Logger"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PollEsNodesVersionOptions.kibanaVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "kibanaVersion",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PollEsNodesVersionOptions.ignoreVersionMismatch",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "ignoreVersionMismatch",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PollEsNodesVersionOptions.esVersionCheckInterval",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "esVersionCheckInterval",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PrebootPlugin",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PrebootPlugin",
|
|
"description": [
|
|
"\nThe interface that should be returned by a `PluginInitializer` for a `preboot` plugin.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PrebootPlugin",
|
|
"text": "PrebootPlugin"
|
|
},
|
|
"<TSetup, TPluginsSetup>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PrebootPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CorePreboot",
|
|
"text": "CorePreboot"
|
|
},
|
|
", plugins: TPluginsSetup) => TSetup"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PrebootPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CorePreboot",
|
|
"text": "CorePreboot"
|
|
}
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PrebootPlugin.setup.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "plugins",
|
|
"description": [],
|
|
"signature": [
|
|
"TPluginsSetup"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PrebootPlugin.stop",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stop",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RegisterDeprecationsConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RegisterDeprecationsConfig",
|
|
"description": [],
|
|
"path": "src/core/server/deprecations/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RegisterDeprecationsConfig.getDeprecations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDeprecations",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.GetDeprecationsContext",
|
|
"text": "GetDeprecationsContext"
|
|
},
|
|
") => ",
|
|
"MaybePromise",
|
|
"<",
|
|
"DeprecationsDetails",
|
|
"[]>"
|
|
],
|
|
"path": "src/core/server/deprecations/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.GetDeprecationsContext",
|
|
"text": "GetDeprecationsContext"
|
|
}
|
|
],
|
|
"path": "src/core/server/deprecations/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RequestHandlerContext",
|
|
"description": [
|
|
"\nBase context passed to a route handler, containing the `core` context part.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
" extends ",
|
|
"RequestHandlerContextBase"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandlerContext.core",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
"Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreRequestHandlerContext",
|
|
"text": "CoreRequestHandlerContext"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ResolveCapabilitiesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ResolveCapabilitiesOptions",
|
|
"description": [
|
|
"\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n"
|
|
],
|
|
"signature": [
|
|
"ResolveCapabilitiesOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "useDefaultCapabilities",
|
|
"description": [
|
|
"\nIndicates if capability switchers are supposed to return a default set of capabilities."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RouteConfig",
|
|
"description": [
|
|
"\nRoute specific configuration."
|
|
],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfig.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [
|
|
"\nThe endpoint _within_ the router path to register the route.\n"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfig.validate",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [
|
|
"\nA schema created with `@kbn/config-schema` that every request will be validated against.\n"
|
|
],
|
|
"signature": [
|
|
"false | ",
|
|
"RouteValidatorFullConfig",
|
|
"<P, Q, B>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfig.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"\nAdditional route options {@link RouteConfigOptions}."
|
|
],
|
|
"signature": [
|
|
"RouteConfigOptions",
|
|
"<Method> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RouteConfigOptions",
|
|
"description": [
|
|
"\nAdditional route options."
|
|
],
|
|
"signature": [
|
|
"RouteConfigOptions",
|
|
"<Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptions.authRequired",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "authRequired",
|
|
"description": [
|
|
"\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered."
|
|
],
|
|
"signature": [
|
|
"boolean | \"optional\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptions.xsrfRequired",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "xsrfRequired",
|
|
"description": [
|
|
"\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default"
|
|
],
|
|
"signature": [
|
|
"(Method extends \"get\" ? never : boolean) | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptions.tags",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "tags",
|
|
"description": [
|
|
"\nAdditional metadata tag strings to attach to the route."
|
|
],
|
|
"signature": [
|
|
"readonly string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptions.body",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"\nAdditional body options {@link RouteConfigOptionsBody}."
|
|
],
|
|
"signature": [
|
|
"(Method extends \"options\" | \"get\" ? undefined : ",
|
|
"RouteConfigOptionsBody",
|
|
") | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptions.timeout",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeout",
|
|
"description": [
|
|
"\nDefines per-route timeouts."
|
|
],
|
|
"signature": [
|
|
"{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptionsBody",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RouteConfigOptionsBody",
|
|
"description": [
|
|
"\nAdditional body options for a route"
|
|
],
|
|
"signature": [
|
|
"RouteConfigOptionsBody"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptionsBody.accepts",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "accepts",
|
|
"description": [
|
|
"\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*"
|
|
],
|
|
"signature": [
|
|
"string | string[] | ",
|
|
"RouteContentType",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptionsBody.maxBytes",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxBytes",
|
|
"description": [
|
|
"\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptionsBody.output",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "output",
|
|
"description": [
|
|
"\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure."
|
|
],
|
|
"signature": [
|
|
"\"data\" | \"stream\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteConfigOptionsBody.parse",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "parse",
|
|
"description": [
|
|
"\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure."
|
|
],
|
|
"signature": [
|
|
"boolean | \"gunzip\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationResultFactory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RouteValidationResultFactory",
|
|
"description": [
|
|
"\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n"
|
|
],
|
|
"signature": [
|
|
"RouteValidationResultFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationResultFactory.ok",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "ok",
|
|
"description": [],
|
|
"signature": [
|
|
"<T>(value: T) => { value: T; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationResultFactory.ok.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationResultFactory.badRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "badRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(error: string | Error, path?: string[] | undefined) => { error: ",
|
|
"RouteValidationError",
|
|
"; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationResultFactory.badRequest.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationResultFactory.badRequest.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidatorConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RouteValidatorConfig",
|
|
"description": [
|
|
"\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n"
|
|
],
|
|
"signature": [
|
|
"RouteValidatorConfig",
|
|
"<P, Q, B>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidatorConfig.params",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"\nValidation logic for the URL params"
|
|
],
|
|
"signature": [
|
|
"RouteValidationSpec",
|
|
"<P> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidatorConfig.query",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [
|
|
"\nValidation logic for the Query params"
|
|
],
|
|
"signature": [
|
|
"RouteValidationSpec",
|
|
"<Q> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidatorConfig.body",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [
|
|
"\nValidation logic for the body payload"
|
|
],
|
|
"signature": [
|
|
"RouteValidationSpec",
|
|
"<B> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidatorOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RouteValidatorOptions",
|
|
"description": [
|
|
"\nAdditional options for the RouteValidator class to modify its default behaviour.\n"
|
|
],
|
|
"signature": [
|
|
"RouteValidatorOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidatorOptions.unsafe",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "unsafe",
|
|
"description": [
|
|
"\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation"
|
|
],
|
|
"signature": [
|
|
"{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObject",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
" The type of Saved Object. Each plugin can define it's own custom Saved Object types."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.updated_at",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "updated_at",
|
|
"description": [
|
|
"Timestamp of the last time this document had been updated."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectError",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.attributes",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectAttributes}"
|
|
],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectReference}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.migrationVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "migrationVersion",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectsMigrationVersion}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.coreMigrationVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "coreMigrationVersion",
|
|
"description": [
|
|
"A semver value that is used when upgrading objects between Kibana versions."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObject.originId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "originId",
|
|
"description": [
|
|
"\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectAttributes",
|
|
"description": [
|
|
"\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectAttributes"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectAttributes.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: SavedObjectAttribute",
|
|
"description": [],
|
|
"signature": [
|
|
"[key: string]: ",
|
|
"SavedObjectAttribute"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReference",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectReference",
|
|
"description": [
|
|
"\nA reference to another saved object.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectReference"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReference.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReference.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReference.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectReferenceWithContext",
|
|
"description": [
|
|
"\nA returned input object or one of its references, with additional context.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectReferenceWithContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"The type of the referenced object"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"The ID of the referenced object"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.originId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "originId",
|
|
"description": [
|
|
"The origin ID of the referenced object (if it has one)"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.spaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spaces",
|
|
"description": [
|
|
"The space(s) that the referenced object exists in"
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.inboundReferences",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inboundReferences",
|
|
"description": [
|
|
"\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation"
|
|
],
|
|
"signature": [
|
|
"{ type: string; id: string; name: string; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.isMissing",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isMissing",
|
|
"description": [
|
|
"Whether or not this object or reference is missing"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingAliases",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesWithMatchingAliases",
|
|
"description": [
|
|
"The space(s) that legacy URL aliases matching this type/id exist in"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingOrigins",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesWithMatchingOrigins",
|
|
"description": [
|
|
"The space(s) that objects matching this origin exist in (including this one)"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBaseOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBaseOptions",
|
|
"description": [
|
|
"\nBase options used by most of the savedObject APIs."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBaseOptions.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [
|
|
"Specify the namespace for this operation"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkCreateObject",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkCreateObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.attributes",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.migrationVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "migrationVersion",
|
|
"description": [
|
|
"{@inheritDoc SavedObjectsMigrationVersion}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "coreMigrationVersion",
|
|
"description": [
|
|
"\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.originId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "originId",
|
|
"description": [
|
|
"Optional ID of the original saved object, if this object's `id` was regenerated"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "initialNamespaces",
|
|
"description": [
|
|
"\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkGetObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkGetObject",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkGetObject"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkGetObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkGetObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkGetObject.fields",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fields",
|
|
"description": [
|
|
"SavedObject fields to include in the response"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkGetObject.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nOptional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the\ntop-level options.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkResolveObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkResolveObject",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkResolveObject"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkResolveObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkResolveObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkResolveResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkResolveResponse",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkResolveResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkResolveResponse.resolved_objects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "resolved_objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsResolveResponse",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkResponse",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkResponse.saved_objects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "saved_objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObject",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkUpdateObject",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<T> extends Pick<",
|
|
"SavedObjectsUpdateOptions",
|
|
"<T>, \"version\" | \"references\">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
" The type of this Saved Object. Each plugin can define it's own custom Saved Object types."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateObject.attributes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectAttributes}"
|
|
],
|
|
"signature": [
|
|
"{ [P in keyof T]?: T[P] | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateObject.namespace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [
|
|
"\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkUpdateOptions",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateOptions",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"The Elasticsearch Refresh setting for this operation"
|
|
],
|
|
"signature": [
|
|
"MutatingOperationRefreshSetting",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsBulkUpdateResponse",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "saved_objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateResponse",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCheckConflictsObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCheckConflictsObject",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsCheckConflictsObject"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCheckConflictsObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCheckConflictsObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCheckConflictsResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCheckConflictsResponse",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsCheckConflictsResponse"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCheckConflictsResponse.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; type: string; error: ",
|
|
"SavedObjectError",
|
|
"; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsClientContract",
|
|
"description": [
|
|
"\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistence and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsClientContract"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.create",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [
|
|
"\nPersists a SavedObject\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, attributes: T, options?: ",
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.create.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.create.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.create.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkCreate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkCreate",
|
|
"description": [
|
|
"\nPersists multiple documents batched together as a single request\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkCreateObject",
|
|
"<T>[], options?: ",
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkCreate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkCreateObject",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkCreate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.checkConflicts",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "checkConflicts",
|
|
"description": [
|
|
"\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n"
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectsCheckConflictsObject",
|
|
"[], options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsCheckConflictsResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.checkConflicts.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCheckConflictsObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.checkConflicts.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.delete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [
|
|
"\nDeletes a SavedObject\n"
|
|
],
|
|
"signature": [
|
|
"(type: string, id: string, options?: ",
|
|
"SavedObjectsDeleteOptions",
|
|
" | undefined) => Promise<{}>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.delete.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.delete.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.delete.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsDeleteOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.find",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "find",
|
|
"description": [
|
|
"\nFind all SavedObjects matching the search query\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown, A = unknown>(options: ",
|
|
"SavedObjectsFindOptions",
|
|
") => Promise<",
|
|
"SavedObjectsFindResponse",
|
|
"<T, A>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.find.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsFindOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkGet",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkGet",
|
|
"description": [
|
|
"\nReturns an array of objects by id\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkGetObject",
|
|
"[], options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkGet.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- an array of ids, or an array of objects containing id, type and optionally fields"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkGetObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkGet.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nRetrieves a single object\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObject",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"- The type of SavedObject to retrieve"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.get.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"- The ID of the SavedObject to retrieve"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.get.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkResolve",
|
|
"type": "Function",
|
|
"tags": [
|
|
"note"
|
|
],
|
|
"label": "bulkResolve",
|
|
"description": [
|
|
"\nResolves an array of objects by id, using any legacy URL aliases if they exist\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkResolveObject",
|
|
"[], options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkResolveResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkResolve.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [
|
|
"- an array of objects containing id, type"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsBulkResolveObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkResolve.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.resolve",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "resolve",
|
|
"description": [
|
|
"\nResolves a single object, using any legacy URL alias if it exists\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsResolveResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.resolve.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"- The type of SavedObject to retrieve"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.resolve.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"- The ID of the SavedObject to retrieve"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.resolve.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.update",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "update",
|
|
"description": [
|
|
"\nUpdates an SavedObject\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
|
"SavedObjectsUpdateOptions",
|
|
"<T> | undefined) => Promise<",
|
|
"SavedObjectsUpdateResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.update.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.update.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.update.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.update.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateOptions",
|
|
"<T> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkUpdate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "bulkUpdate",
|
|
"description": [
|
|
"\nBulk Updates multiple SavedObject at once\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(objects: ",
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<T>[], options?: ",
|
|
"SavedObjectsBulkUpdateOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsBulkUpdateResponse",
|
|
"<T>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkUpdate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateObject",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.bulkUpdate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBulkUpdateOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.removeReferencesTo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeReferencesTo",
|
|
"description": [
|
|
"\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference."
|
|
],
|
|
"signature": [
|
|
"(type: string, id: string, options?: ",
|
|
"SavedObjectsRemoveReferencesToOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsRemoveReferencesToResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.removeReferencesTo.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.removeReferencesTo.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.removeReferencesTo.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsRemoveReferencesToOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.openPointInTimeForType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openPointInTimeForType",
|
|
"description": [
|
|
"\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method."
|
|
],
|
|
"signature": [
|
|
"(type: string | string[], options?: ",
|
|
"SavedObjectsOpenPointInTimeOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsOpenPointInTimeResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.openPointInTimeForType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.openPointInTimeForType.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsOpenPointInTimeOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.closePointInTime",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "closePointInTime",
|
|
"description": [
|
|
"\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method."
|
|
],
|
|
"signature": [
|
|
"(id: string, options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsClosePointInTimeResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.closePointInTime.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.closePointInTime.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.createPointInTimeFinder",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createPointInTimeFinder",
|
|
"description": [
|
|
"\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThe generator wraps calls to {@link SavedObjectsClient.find} and iterates\nover multiple pages of results using `_pit` and `search_after`. This will\nopen a new Point-In-Time (PIT), and continue paging until a set of\nresults is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n"
|
|
],
|
|
"signature": [
|
|
"<T = unknown, A = unknown>(findOptions: ",
|
|
"SavedObjectsCreatePointInTimeFinderOptions",
|
|
", dependencies?: ",
|
|
"SavedObjectsCreatePointInTimeFinderDependencies",
|
|
" | undefined) => ",
|
|
"ISavedObjectsPointInTimeFinder",
|
|
"<T, A>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.createPointInTimeFinder.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "findOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreatePointInTimeFinderOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.createPointInTimeFinder.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dependencies",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreatePointInTimeFinderDependencies",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "collectMultiNamespaceReferences",
|
|
"description": [
|
|
"\nGets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type.\n"
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"[], options?: ",
|
|
"SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.updateObjectsSpaces",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateObjectsSpaces",
|
|
"description": [
|
|
"\nUpdates one or more objects to add and/or remove them from specified spaces.\n"
|
|
],
|
|
"signature": [
|
|
"(objects: ",
|
|
"SavedObjectsUpdateObjectsSpacesObject",
|
|
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
|
"SavedObjectsUpdateObjectsSpacesOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsUpdateObjectsSpacesResponse",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesToAdd",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesToRemove",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesOptions",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClosePointInTimeResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsClosePointInTimeResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsClosePointInTimeResponse"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "succeeded",
|
|
"description": [
|
|
"\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "num_freed",
|
|
"description": [
|
|
"\nThe number of search contexts that have been successfully closed."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCollectMultiNamespaceReferencesObject",
|
|
"description": [
|
|
"\nAn object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the\n`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option).\n\nNote: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with\nthe `namespaceType: 'multiple'`).\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsCollectMultiNamespaceReferencesObject"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
"description": [
|
|
"\nOptions for collecting references.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsCollectMultiNamespaceReferencesOptions",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions.purpose",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "purpose",
|
|
"description": [
|
|
"Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences'"
|
|
],
|
|
"signature": [
|
|
"\"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCollectMultiNamespaceReferencesResponse",
|
|
"description": [
|
|
"\nThe response when object references are collected.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsCollectMultiNamespaceReferencesResponse"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse.objects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReferenceWithContext",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCreateOptions",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsCreateOptions",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"(not recommended) Specify an id for the document"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.overwrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [
|
|
"Overwrite existing documents (defaults to false)"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.migrationVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "migrationVersion",
|
|
"description": [
|
|
"{@inheritDoc SavedObjectsMigrationVersion}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "coreMigrationVersion",
|
|
"description": [
|
|
"\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"The Elasticsearch Refresh setting for this operation"
|
|
],
|
|
"signature": [
|
|
"MutatingOperationRefreshSetting",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.originId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "originId",
|
|
"description": [
|
|
"Optional ID of the original saved object, if this object's `id` was regenerated"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreateOptions.initialNamespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "initialNamespaces",
|
|
"description": [
|
|
"\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsCreatePointInTimeFinderDependencies",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsCreatePointInTimeFinderDependencies"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "client",
|
|
"description": [],
|
|
"signature": [
|
|
"{ find: <T = unknown, A = unknown>(options: ",
|
|
"SavedObjectsFindOptions",
|
|
") => Promise<",
|
|
"SavedObjectsFindResponse",
|
|
"<T, A>>; closePointInTime: (id: string, options?: ",
|
|
"SavedObjectsBaseOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsClosePointInTimeResponse",
|
|
">; openPointInTimeForType: (type: string | string[], options?: ",
|
|
"SavedObjectsOpenPointInTimeOptions",
|
|
" | undefined) => Promise<",
|
|
"SavedObjectsOpenPointInTimeResponse",
|
|
">; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsDeleteByNamespaceOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsDeleteByNamespaceOptions",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsDeleteByNamespaceOptions",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"The Elasticsearch supports only boolean flag for this operation"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsDeleteOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsDeleteOptions",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsDeleteOptions",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsDeleteOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"The Elasticsearch Refresh setting for this operation"
|
|
],
|
|
"signature": [
|
|
"MutatingOperationRefreshSetting",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsDeleteOptions.force",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "force",
|
|
"description": [
|
|
"Force deletion of an object that exists in multiple namespaces"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsFindOptions",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsFindOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.perPage",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "perPage",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.sortField",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sortField",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.sortOrder",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sortOrder",
|
|
"description": [],
|
|
"signature": [
|
|
"SortOrder",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.fields",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fields",
|
|
"description": [
|
|
"\nAn array of fields to include in the results"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.search",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [
|
|
"Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.searchFields",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "searchFields",
|
|
"description": [
|
|
"The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.searchAfter",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "searchAfter",
|
|
"description": [
|
|
"\nUse the sort values from the previous page to retrieve the next page of results."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.rootSearchFields",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "rootSearchFields",
|
|
"description": [
|
|
"\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.hasReference",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hasReference",
|
|
"description": [
|
|
"\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsFindOptionsReference",
|
|
" | ",
|
|
"SavedObjectsFindOptionsReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.hasReferenceOperator",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hasReferenceOperator",
|
|
"description": [
|
|
"\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`"
|
|
],
|
|
"signature": [
|
|
"\"AND\" | \"OR\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.defaultSearchOperator",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "defaultSearchOperator",
|
|
"description": [
|
|
"\nThe search operator to use with the provided filter. Defaults to `OR`"
|
|
],
|
|
"signature": [
|
|
"\"AND\" | \"OR\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.filter",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "filter",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.aggs",
|
|
"type": "Object",
|
|
"tags": [
|
|
"alpha"
|
|
],
|
|
"label": "aggs",
|
|
"description": [
|
|
"\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n"
|
|
],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"AggregationsAggregationContainer",
|
|
"> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "typeToNamespacesMap",
|
|
"description": [
|
|
"\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace."
|
|
],
|
|
"signature": [
|
|
"Map<string, string[] | undefined> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.preference",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "preference",
|
|
"description": [
|
|
"An optional ES preference value to be used for the query"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptions.pit",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "pit",
|
|
"description": [
|
|
"\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsPitParams",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptionsReference",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsFindOptionsReference",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsFindOptionsReference"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptionsReference.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindOptionsReference.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsFindResponse",
|
|
"description": [
|
|
"\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsFindResponse",
|
|
"<T, A>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResponse.aggregations",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "aggregations",
|
|
"description": [],
|
|
"signature": [
|
|
"A | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResponse.saved_objects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "saved_objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsFindResult",
|
|
"<T>[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResponse.total",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "total",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResponse.per_page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "per_page",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResponse.page",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "page",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResponse.pit_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "pit_id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsFindResult",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsFindResult",
|
|
"<T> extends ",
|
|
"SavedObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResult.score",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "score",
|
|
"description": [
|
|
"\nThe Elasticsearch `_score` of this result."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsFindResult.sort",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "sort",
|
|
"description": [
|
|
"\nThe Elasticsearch `sort` value of this result.\n"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportActionRequiredWarning",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportActionRequiredWarning",
|
|
"description": [
|
|
"\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportActionRequiredWarning"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportActionRequiredWarning.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"action_required\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportActionRequiredWarning.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"The translated message to display to the user."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "actionPath",
|
|
"description": [
|
|
"The path (without the basePath) that the user should be redirect to address this warning."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "buttonLabel",
|
|
"description": [
|
|
"An optional label to use for the link button. If unspecified, a default label will be used."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportAmbiguousConflictError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportAmbiguousConflictError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportAmbiguousConflictError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportAmbiguousConflictError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ambiguous_conflict\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "destinations",
|
|
"description": [],
|
|
"signature": [
|
|
"{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportConflictError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportConflictError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to a conflict."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportConflictError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportConflictError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"conflict\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportConflictError.destinationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "destinationId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportFailure",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportFailure",
|
|
"description": [
|
|
"\nRepresents a failure to import."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportFailure"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportFailure.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportFailure.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportFailure.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title?: string | undefined; icon?: string | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportFailure.overwrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [
|
|
"\nIf `overwrite` is specified, an attempt was made to overwrite an existing object."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportFailure.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportConflictError",
|
|
" | ",
|
|
"SavedObjectsImportAmbiguousConflictError",
|
|
" | ",
|
|
"SavedObjectsImportUnsupportedTypeError",
|
|
" | ",
|
|
"SavedObjectsImportMissingReferencesError",
|
|
" | ",
|
|
"SavedObjectsImportUnknownError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportMissingReferencesError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportMissingReferencesError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to missing references."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportMissingReferencesError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportMissingReferencesError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"missing_references\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportMissingReferencesError.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; id: string; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportResponse",
|
|
"description": [
|
|
"\nThe response describing the result of an import."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportResponse"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportResponse.success",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "success",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportResponse.successCount",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "successCount",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportResponse.successResults",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "successResults",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportSuccess",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportResponse.warnings",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "warnings",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportWarning",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportResponse.errors",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "errors",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsImportFailure",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportRetry",
|
|
"description": [
|
|
"\nDescribes a retry operation for importing a saved object."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportRetry"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry.overwrite",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry.destinationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "destinationId",
|
|
"description": [
|
|
"\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry.replaceReferences",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "replaceReferences",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; from: string; to: string; }[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry.createNewCopy",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "createNewCopy",
|
|
"description": [
|
|
"\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ignoreMissingReferences",
|
|
"description": [
|
|
"\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSimpleWarning",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportSimpleWarning",
|
|
"description": [
|
|
"\nA simple informative warning that will be displayed to the user.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportSimpleWarning"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSimpleWarning.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"simple\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSimpleWarning.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [
|
|
"The translated message to display to the user"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSuccess",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportSuccess",
|
|
"description": [
|
|
"\nRepresents a successful import."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportSuccess"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSuccess.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSuccess.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSuccess.destinationId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "destinationId",
|
|
"description": [
|
|
"\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSuccess.createNewCopy",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "createNewCopy",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "spaces",
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx"
|
|
},
|
|
{
|
|
"plugin": "savedObjectsManagement",
|
|
"path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSuccess.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title?: string | undefined; icon?: string | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportSuccess.overwrite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "overwrite",
|
|
"description": [
|
|
"\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportUnknownError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportUnknownError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to an unknown reason."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportUnknownError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportUnknownError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"unknown\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportUnknownError.message",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "message",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportUnknownError.statusCode",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "statusCode",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportUnsupportedTypeError",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportUnsupportedTypeError",
|
|
"description": [
|
|
"\nRepresents a failure to import due to having an unsupported saved object type."
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportUnsupportedTypeError"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportUnsupportedTypeError.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"unsupported_type\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterField",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsIncrementCounterField",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsIncrementCounterField"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterField.fieldName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fieldName",
|
|
"description": [
|
|
"The field name to increment the counter by."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterField.incrementBy",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "incrementBy",
|
|
"description": [
|
|
"The number to increment the field by (defaults to 1)."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsIncrementCounterOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsIncrementCounterOptions",
|
|
"<Attributes> extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterOptions.initialize",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "initialize",
|
|
"description": [
|
|
"\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "migrationVersion",
|
|
"description": [
|
|
"{@link SavedObjectsMigrationVersion}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}"
|
|
],
|
|
"signature": [
|
|
"MutatingOperationRefreshSetting",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "upsertAttributes",
|
|
"description": [
|
|
"\nAttributes to use when upserting the document if it doesn't exist."
|
|
],
|
|
"signature": [
|
|
"Attributes | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsMigrationVersion",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsMigrationVersion",
|
|
"description": [
|
|
"\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsMigrationVersion"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsMigrationVersion.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[pluginName: string]: string",
|
|
"description": [],
|
|
"signature": [
|
|
"[pluginName: string]: string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsOpenPointInTimeOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsOpenPointInTimeOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsOpenPointInTimeOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keepAlive",
|
|
"description": [
|
|
"\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsOpenPointInTimeOptions.preference",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "preference",
|
|
"description": [
|
|
"\nAn optional ES preference value to be used for the query."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsOpenPointInTimeOptions.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nAn optional list of namespaces to be used when opening the PIT.\n\nWhen the spaces plugin is enabled:\n - this will default to the user's current space (as determined by the URL)\n - if specified, the user's current space will be ignored\n - `['*']` will search across all available spaces"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsOpenPointInTimeResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsOpenPointInTimeResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsOpenPointInTimeResponse"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsOpenPointInTimeResponse.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nPIT ID returned from ES."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsPitParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsPitParams",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsPitParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsPitParams.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsPitParams.keepAlive",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keepAlive",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsRemoveReferencesToOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsRemoveReferencesToOptions",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsRemoveReferencesToOptions",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"The Elasticsearch Refresh setting for this operation. Defaults to `true`"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsRemoveReferencesToResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsRemoveReferencesToResponse",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsRemoveReferencesToResponse",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsRemoveReferencesToResponse.updated",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "updated",
|
|
"description": [
|
|
"The number of objects that have been updated by this operation"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsResolveResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsResolveResponse",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsResolveResponse",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsResolveResponse.saved_object",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "saved_object",
|
|
"description": [
|
|
"\nThe saved object that was found."
|
|
],
|
|
"signature": [
|
|
"SavedObject",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsResolveResponse.outcome",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "outcome",
|
|
"description": [
|
|
"\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID."
|
|
],
|
|
"signature": [
|
|
"\"exactMatch\" | \"aliasMatch\" | \"conflict\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsResolveResponse.alias_target_id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "alias_target_id",
|
|
"description": [
|
|
"\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsResolveResponse.alias_purpose",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "alias_purpose",
|
|
"description": [
|
|
"\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)."
|
|
],
|
|
"signature": [
|
|
"\"savedObjectConversion\" | \"savedObjectImport\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsUpdateObjectsSpacesObject",
|
|
"description": [
|
|
"\nAn object that should have its spaces updated.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesObject"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"The type of the object to update"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"The ID of the object to update"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsUpdateObjectsSpacesOptions",
|
|
"description": [
|
|
"\nOptions for the update operation.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesOptions",
|
|
" extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"The Elasticsearch Refresh setting for this operation"
|
|
],
|
|
"signature": [
|
|
"MutatingOperationRefreshSetting",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsUpdateObjectsSpacesResponse",
|
|
"description": [
|
|
"\nThe response when objects' spaces are updated.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesResponse"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponse.objects",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesResponseObject",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsUpdateObjectsSpacesResponseObject",
|
|
"description": [
|
|
"\nDetails about a specific object's update result.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsUpdateObjectsSpacesResponseObject"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"The type of the referenced object"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"The ID of the referenced object"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spaces",
|
|
"description": [
|
|
"The space(s) that the referenced object exists in"
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"Included if there was an error updating this object's spaces"
|
|
],
|
|
"signature": [
|
|
"SavedObjectError",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsUpdateOptions",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsUpdateOptions",
|
|
"<Attributes> extends ",
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateOptions.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nAn opaque version number which changes on each successful write operation.\nCan be used for implementing optimistic concurrency control."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateOptions.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [
|
|
"{@inheritdoc SavedObjectReference}"
|
|
],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateOptions.refresh",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "refresh",
|
|
"description": [
|
|
"The Elasticsearch Refresh setting for this operation"
|
|
],
|
|
"signature": [
|
|
"MutatingOperationRefreshSetting",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateOptions.upsert",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "upsert",
|
|
"description": [
|
|
"If specified, will be used to perform an upsert if the document doesn't exist"
|
|
],
|
|
"signature": [
|
|
"Attributes | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateOptions.retryOnConflict",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "retryOnConflict",
|
|
"description": [
|
|
"\nThe Elasticsearch `retry_on_conflict` setting for this operation.\nDefaults to `0` when `version` is provided, `3` otherwise."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateResponse",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectsUpdateResponse",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsUpdateResponse",
|
|
"<T> extends Omit<",
|
|
"SavedObject",
|
|
"<T>, \"attributes\" | \"references\">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateResponse.attributes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [P in keyof T]?: T[P] | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsUpdateResponse.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatus",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ServiceStatus",
|
|
"description": [
|
|
"\nThe current status of a service at a point in time.\n"
|
|
],
|
|
"signature": [
|
|
"ServiceStatus",
|
|
"<Meta>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatus.level",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "level",
|
|
"description": [
|
|
"\nThe current availability level of the service."
|
|
],
|
|
"signature": [
|
|
"Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatus.summary",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "summary",
|
|
"description": [
|
|
"\nA high-level summary of the service status."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatus.detail",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "detail",
|
|
"description": [
|
|
"\nA more detailed description of the service status."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatus.documentationUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "documentationUrl",
|
|
"description": [
|
|
"\nA URL to open in a new tab about how to resolve or troubleshoot the problem."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatus.meta",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features."
|
|
],
|
|
"signature": [
|
|
"Meta | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionCookieValidationResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SessionCookieValidationResult",
|
|
"description": [
|
|
"\nReturn type from a function to validate cookie contents."
|
|
],
|
|
"signature": [
|
|
"SessionCookieValidationResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionCookieValidationResult.isValid",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isValid",
|
|
"description": [
|
|
"\nWhether the cookie is valid or not."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionCookieValidationResult.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [
|
|
"\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorage",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SessionStorage",
|
|
"description": [
|
|
"\nProvides an interface to store and retrieve data across requests."
|
|
],
|
|
"signature": [
|
|
"SessionStorage",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorage.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nRetrieves session value from the session storage."
|
|
],
|
|
"signature": [
|
|
"() => Promise<T | null>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorage.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [
|
|
"\nPuts current session value into the session storage."
|
|
],
|
|
"signature": [
|
|
"(sessionValue: T) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorage.set.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "sessionValue",
|
|
"description": [
|
|
"- value to put"
|
|
],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorage.clear",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clear",
|
|
"description": [
|
|
"\nClears current session."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageCookieOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SessionStorageCookieOptions",
|
|
"description": [
|
|
"\nConfiguration used to create HTTP session storage based on top of cookie mechanism."
|
|
],
|
|
"signature": [
|
|
"SessionStorageCookieOptions",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageCookieOptions.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nName of the session cookie."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageCookieOptions.encryptionKey",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "encryptionKey",
|
|
"description": [
|
|
"\nA key used to encrypt a cookie's value. Should be at least 32 characters long."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageCookieOptions.validate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validate",
|
|
"description": [
|
|
"\nFunction called to validate a cookie's decrypted value."
|
|
],
|
|
"signature": [
|
|
"(sessionValue: T | T[]) => ",
|
|
"SessionCookieValidationResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageCookieOptions.validate.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sessionValue",
|
|
"description": [],
|
|
"signature": [
|
|
"T | T[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageCookieOptions.isSecure",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isSecure",
|
|
"description": [
|
|
"\nFlag indicating whether the cookie should be sent only via a secure connection."
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageCookieOptions.sameSite",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sameSite",
|
|
"description": [
|
|
"\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite"
|
|
],
|
|
"signature": [
|
|
"\"None\" | \"Strict\" | \"Lax\" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageFactory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SessionStorageFactory",
|
|
"description": [
|
|
"\nSessionStorage factory to bind one to an incoming request"
|
|
],
|
|
"signature": [
|
|
"SessionStorageFactory",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageFactory.asScoped",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asScoped",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
"SessionStorage",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SessionStorageFactory.asScoped.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ShipperClassConstructor",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShipperClassConstructor",
|
|
"description": [
|
|
"\nConstructor of a {@link IShipper}"
|
|
],
|
|
"signature": [
|
|
"ShipperClassConstructor",
|
|
"<Shipper, Config>"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ShipperClassConstructor.shipperName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "shipperName",
|
|
"description": [
|
|
"\nThe shipper's unique name"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ShipperClassConstructor.new",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "new",
|
|
"description": [
|
|
"\nThe constructor"
|
|
],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ShipperClassConstructor.new.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [
|
|
"The shipper's custom config"
|
|
],
|
|
"signature": [
|
|
"Config"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ShipperClassConstructor.new.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initContext",
|
|
"description": [
|
|
"Common context {@link AnalyticsClientInitContext }"
|
|
],
|
|
"signature": [
|
|
"AnalyticsClientInitContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "StatusServiceSetup",
|
|
"description": [
|
|
"\nAPI for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.\n"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup.core$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core$",
|
|
"description": [
|
|
"\nCurrent status for all Core services."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStatus",
|
|
"text": "CoreStatus"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup.overall$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "overall$",
|
|
"description": [
|
|
"\nOverall system status for all of Kibana.\n"
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ServiceStatus",
|
|
"<unknown>>"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [
|
|
"\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n"
|
|
],
|
|
"signature": [
|
|
"(status$: ",
|
|
"Observable",
|
|
"<",
|
|
"ServiceStatus",
|
|
"<unknown>>) => void"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup.set.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "status$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ServiceStatus",
|
|
"<unknown>>"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup.dependencies$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dependencies$",
|
|
"description": [
|
|
"\nCurrent status for all plugins this plugin depends on.\nEach key of the `Record` is a plugin id."
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<Record<string, ",
|
|
"ServiceStatus",
|
|
"<unknown>>>"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup.derivedStatus$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "derivedStatus$",
|
|
"description": [
|
|
"\nThe status of this plugin as derived from its dependencies.\n"
|
|
],
|
|
"signature": [
|
|
"Observable",
|
|
"<",
|
|
"ServiceStatus",
|
|
"<unknown>>"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StatusServiceSetup.isStatusPageAnonymous",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isStatusPageAnonymous",
|
|
"description": [
|
|
"\nWhether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is\npresent."
|
|
],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/core/server/status/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.TelemetryCounter",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TelemetryCounter",
|
|
"description": [
|
|
"\nShape of the events emitted by the telemetryCounter$ observable"
|
|
],
|
|
"signature": [
|
|
"TelemetryCounter"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.TelemetryCounter.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\n{@link TelemetryCounterType}"
|
|
],
|
|
"signature": [
|
|
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.TelemetryCounter.source",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [
|
|
"\nWho emitted the event? It can be \"client\" or the name of the shipper."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.TelemetryCounter.event_type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "event_type",
|
|
"description": [
|
|
"\nThe event type the success/failure/drop event refers to."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.TelemetryCounter.code",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "code",
|
|
"description": [
|
|
"\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.TelemetryCounter.count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [
|
|
"\nThe number of events that this counter refers to."
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UiSettingsParams",
|
|
"description": [
|
|
"\nUiSettings parameters defined by the plugins."
|
|
],
|
|
"signature": [
|
|
"UiSettingsParams",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"title in the UI"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.value",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [
|
|
"default value to fall back to if a user doesn't provide any"
|
|
],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"description provided to a user in UI"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.category",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "category",
|
|
"description": [
|
|
"used to group the configured setting in the UI"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.options",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"array of permitted values for this setting"
|
|
],
|
|
"signature": [
|
|
"number[] | string[] | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.optionLabels",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "optionLabels",
|
|
"description": [
|
|
"text labels for 'select' type UI element"
|
|
],
|
|
"signature": [
|
|
"Record<string, string> | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.requiresPageReload",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requiresPageReload",
|
|
"description": [
|
|
"a flag indicating whether new value applying requires page reloading"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.readonly",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "readonly",
|
|
"description": [
|
|
"a flag indicating that value cannot be changed"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.sensitive",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "sensitive",
|
|
"description": [
|
|
"\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"defines a type of UI element {@link UiSettingsType}"
|
|
],
|
|
"signature": [
|
|
"UiSettingsType",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.deprecation",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deprecation",
|
|
"description": [
|
|
"optional deprecation information. Used to generate a deprecation warning."
|
|
],
|
|
"signature": [
|
|
"DeprecationSettings",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [
|
|
"\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.schema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schema",
|
|
"description": [],
|
|
"signature": [
|
|
"Type",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsParams.metric",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "metric",
|
|
"description": [
|
|
"\nMetric to track once this property changes"
|
|
],
|
|
"signature": [
|
|
"{ type: string; name: string; } | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "advancedSettings",
|
|
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts"
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"path": "src/plugins/discover/server/ui_settings.ts"
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"path": "src/plugins/discover/server/ui_settings.ts"
|
|
},
|
|
{
|
|
"plugin": "discover",
|
|
"path": "src/plugins/discover/server/ui_settings.ts"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsRequestHandlerContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UiSettingsRequestHandlerContext",
|
|
"description": [
|
|
"\nCore's `uiSettings` request handler context."
|
|
],
|
|
"path": "src/core/server/ui_settings/ui_settings_route_handler_context.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsRequestHandlerContext.client",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "client",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"path": "src/core/server/ui_settings/ui_settings_route_handler_context.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UiSettingsServiceSetup",
|
|
"description": [],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsServiceSetup.register",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "register",
|
|
"description": [
|
|
"\nSets settings with default values for the uiSettings."
|
|
],
|
|
"signature": [
|
|
"(settings: Record<string, ",
|
|
"UiSettingsParams",
|
|
"<unknown>>) => void"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsServiceSetup.register.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "settings",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"UiSettingsParams",
|
|
"<unknown>>"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsServiceStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UiSettingsServiceStart",
|
|
"description": [],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsServiceStart.asScopedToClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "asScopedToClient",
|
|
"description": [
|
|
"\nCreates a {@link IUiSettingsClient} with provided *scoped* saved objects client.\n\nThis should only be used in the specific case where the client needs to be accessed\nfrom outside of the scope of a {@link RequestHandler}.\n"
|
|
],
|
|
"signature": [
|
|
"(savedObjectsClient: ",
|
|
"SavedObjectsClientContract",
|
|
") => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsServiceStart.asScopedToClient.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsClientContract"
|
|
],
|
|
"path": "src/core/server/ui_settings/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerNotHandledResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnauthorizedErrorHandlerNotHandledResult",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerNotHandledResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerNotHandledResult.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"notHandled\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnauthorizedErrorHandlerOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerOptions.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseError",
|
|
" & { statusCode: 401; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerOptions.request",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerResultRetryParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnauthorizedErrorHandlerResultRetryParams",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerResultRetryParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerResultRetryParams.authHeaders",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "authHeaders",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: string | string[]; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerRetryResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnauthorizedErrorHandlerRetryResult",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerRetryResult",
|
|
" extends ",
|
|
"UnauthorizedErrorHandlerResultRetryParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerRetryResult.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"retry\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerToolkit",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnauthorizedErrorHandlerToolkit",
|
|
"description": [
|
|
"\nToolkit passed to a {@link UnauthorizedErrorHandler} used to generate responses from the handler"
|
|
],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerToolkit.notHandled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "notHandled",
|
|
"description": [
|
|
"\nThe handler cannot handle the error, or was not able to authenticate."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"UnauthorizedErrorHandlerNotHandledResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerToolkit.retry",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "retry",
|
|
"description": [
|
|
"\nThe handler was able to authenticate. Will retry the failed request with new auth headers"
|
|
],
|
|
"signature": [
|
|
"(params: ",
|
|
"UnauthorizedErrorHandlerResultRetryParams",
|
|
") => ",
|
|
"UnauthorizedErrorHandlerRetryResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerToolkit.retry.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerResultRetryParams"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UserProvidedValues",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserProvidedValues",
|
|
"description": [
|
|
"\nDescribes the values explicitly set by user."
|
|
],
|
|
"signature": [
|
|
"UserProvidedValues",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UserProvidedValues.userValue",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "userValue",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UserProvidedValues.isOverridden",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isOverridden",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResultType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "AuthResultType",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultType"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthStatus",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "AuthStatus",
|
|
"description": [
|
|
"\nStatus indicating an outcome of the authentication."
|
|
],
|
|
"signature": [
|
|
"AuthStatus"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "PluginType",
|
|
"description": [],
|
|
"signature": [
|
|
"PluginType"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AddConfigDeprecation",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AddConfigDeprecation",
|
|
"description": [
|
|
"\nConfig deprecation hook used when invoking a {@link ConfigDeprecation}\n"
|
|
],
|
|
"signature": [
|
|
"(details: ",
|
|
"DeprecatedConfigDetails",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AddConfigDeprecation.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"DeprecatedConfigDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsServicePreboot",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AnalyticsServicePreboot",
|
|
"description": [
|
|
"\nExposes the public APIs of the AnalyticsClient during the preboot phase\n{@link AnalyticsClient}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-analytics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsServiceSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AnalyticsServiceSetup",
|
|
"description": [
|
|
"\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
|
"EventTypeOpts",
|
|
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
|
"IShipper",
|
|
", ShipperConfig>(Shipper: ",
|
|
"ShipperClassConstructor",
|
|
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
|
"RegisterShipperOpts",
|
|
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
|
"ContextProviderOpts",
|
|
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-analytics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AnalyticsServiceStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AnalyticsServiceStart",
|
|
"description": [
|
|
"\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}"
|
|
],
|
|
"signature": [
|
|
"{ optIn: (optInConfig: ",
|
|
"OptInConfig",
|
|
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
|
"Observable",
|
|
"<",
|
|
"TelemetryCounter",
|
|
">; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-analytics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.APP_WRAPPER_CLASS",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "APP_WRAPPER_CLASS",
|
|
"description": [
|
|
"\nThe class name for top level *and* nested application wrappers to ensure proper layout"
|
|
],
|
|
"signature": [
|
|
"\"kbnAppWrapper\""
|
|
],
|
|
"path": "src/core/utils/app_wrapper_class.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AppenderConfigType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AppenderConfigType",
|
|
"description": [],
|
|
"signature": [
|
|
"ConsoleAppenderConfig",
|
|
" | ",
|
|
"FileAppenderConfig",
|
|
" | ",
|
|
"RewriteAppenderConfig",
|
|
" | ",
|
|
"RollingFileAppenderConfig"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthenticationHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AuthenticationHandler",
|
|
"description": [
|
|
"\nSee {@link AuthToolkit}."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, response: ",
|
|
"LifecycleResponseFactory",
|
|
", toolkit: ",
|
|
"AuthToolkit",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"AuthResult",
|
|
" | Promise<",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"AuthResult",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthenticationHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthenticationHandler.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthenticationHandler.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthHeaders",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AuthHeaders",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: string | string[]; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.AuthResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AuthResult",
|
|
"description": [],
|
|
"signature": [
|
|
"AuthResultAuthenticated",
|
|
" | ",
|
|
"AuthResultNotHandled",
|
|
" | ",
|
|
"AuthResultRedirected"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesProvider",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CapabilitiesProvider",
|
|
"description": [
|
|
"\nSee {@link CapabilitiesSetup}"
|
|
],
|
|
"signature": [
|
|
"() => Partial<",
|
|
"Capabilities",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSwitcher",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CapabilitiesSwitcher",
|
|
"description": [
|
|
"\nSee {@link CapabilitiesSetup}"
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, uiCapabilities: ",
|
|
"Capabilities",
|
|
", useDefaultCapabilities: boolean) => ",
|
|
"MaybePromise",
|
|
"<Partial<",
|
|
"Capabilities",
|
|
">>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSwitcher.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSwitcher.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiCapabilities",
|
|
"description": [],
|
|
"signature": [
|
|
"Capabilities"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CapabilitiesSwitcher.$3",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "useDefaultCapabilities",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecation",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ConfigDeprecation",
|
|
"description": [
|
|
"\nConfiguration deprecation returned from {@link ConfigDeprecationProvider} that handles a single deprecation from the configuration.\n"
|
|
],
|
|
"signature": [
|
|
"(config: Readonly<{ [x: string]: any; }>, fromPath: string, addDeprecation: ",
|
|
"AddConfigDeprecation",
|
|
", context: ",
|
|
"ConfigDeprecationContext",
|
|
") => void | ",
|
|
"ConfigDeprecationCommand"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecation.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [
|
|
"must not be mutated, return {@link ConfigDeprecationCommand } to change config shape."
|
|
],
|
|
"signature": [
|
|
"{ readonly [x: string]: any; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecation.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fromPath",
|
|
"description": [],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecation.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addDeprecation",
|
|
"description": [],
|
|
"signature": [
|
|
"(details: ",
|
|
"DeprecatedConfigDetails",
|
|
") => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecation.$3.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "details",
|
|
"description": [],
|
|
"signature": [
|
|
"DeprecatedConfigDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecation.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"ConfigDeprecationContext"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationProvider",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ConfigDeprecationProvider",
|
|
"description": [
|
|
"\nA provider that should returns a list of {@link ConfigDeprecation}.\n\nSee {@link ConfigDeprecationFactory} for more usage examples.\n"
|
|
],
|
|
"signature": [
|
|
"(factory: ",
|
|
"ConfigDeprecationFactory",
|
|
") => ",
|
|
"ConfigDeprecation",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigDeprecationProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "factory",
|
|
"description": [],
|
|
"signature": [
|
|
"ConfigDeprecationFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ConfigPath",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ConfigPath",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__config/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.CustomRequestHandlerContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CustomRequestHandlerContext",
|
|
"description": [
|
|
"\nMixin allowing plugins to define their own request handler contexts.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.RequestHandlerContext",
|
|
"text": "RequestHandlerContext"
|
|
},
|
|
" & { [Key in keyof T]: T[Key] extends Promise<unknown> ? T[Key] : Promise<T[Key]>; }"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DeprecationsDetails",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DeprecationsDetails",
|
|
"description": [],
|
|
"signature": [
|
|
"ConfigDeprecationDetails",
|
|
" | ",
|
|
"FeatureDeprecationDetails"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-deprecations-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DestructiveRouteMethod",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DestructiveRouteMethod",
|
|
"description": [
|
|
"\nSet of HTTP methods changing the state of the server."
|
|
],
|
|
"signature": [
|
|
"\"delete\" | \"post\" | \"put\" | \"patch\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.DocLinksServiceStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DocLinksServiceStart",
|
|
"description": [],
|
|
"signature": [
|
|
"DocLinksServiceSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Ecs",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Ecs",
|
|
"description": [
|
|
"\nRepresents the full ECS schema.\n"
|
|
],
|
|
"signature": [
|
|
"EcsBase",
|
|
" & ",
|
|
"EcsTracing",
|
|
" & { ecs: ",
|
|
"EcsField",
|
|
"; agent?: ",
|
|
"EcsAgent",
|
|
" | undefined; as?: ",
|
|
"EcsAutonomousSystem",
|
|
" | undefined; client?: ",
|
|
"EcsClient",
|
|
" | undefined; cloud?: ",
|
|
"EcsCloud",
|
|
" | undefined; container?: ",
|
|
"EcsContainer",
|
|
" | undefined; data_stream?: ",
|
|
"EcsDataStream",
|
|
" | undefined; destination?: ",
|
|
"EcsDestination",
|
|
" | undefined; dns?: ",
|
|
"EcsDns",
|
|
" | undefined; email?: ",
|
|
"EcsEmail",
|
|
" | undefined; error?: ",
|
|
"EcsError",
|
|
" | undefined; event?: ",
|
|
"EcsEvent",
|
|
" | undefined; faas?: ",
|
|
"EcsFaas",
|
|
" | undefined; file?: ",
|
|
"EcsFile",
|
|
" | undefined; group?: ",
|
|
"EcsGroup",
|
|
" | undefined; host?: ",
|
|
"EcsHost",
|
|
" | undefined; http?: ",
|
|
"EcsHttp",
|
|
" | undefined; log?: ",
|
|
"EcsLog",
|
|
" | undefined; network?: ",
|
|
"EcsNetwork",
|
|
" | undefined; observer?: ",
|
|
"EcsObserver",
|
|
" | undefined; orchestrator?: ",
|
|
"EcsOrchestrator",
|
|
" | undefined; organization?: ",
|
|
"EcsOrganization",
|
|
" | undefined; package?: ",
|
|
"EcsPackage",
|
|
" | undefined; process?: ",
|
|
"EcsProcess",
|
|
" | undefined; registry?: ",
|
|
"EcsRegistry",
|
|
" | undefined; related?: ",
|
|
"EcsRelated",
|
|
" | undefined; rule?: ",
|
|
"EcsRule",
|
|
" | undefined; server?: ",
|
|
"EcsServer",
|
|
" | undefined; service?: ",
|
|
"EcsService",
|
|
" | undefined; source?: ",
|
|
"EcsSource",
|
|
" | undefined; threat?: ",
|
|
"EcsThreat",
|
|
" | undefined; tls?: ",
|
|
"EcsTls",
|
|
" | undefined; url?: ",
|
|
"EcsUrl",
|
|
" | undefined; user?: ",
|
|
"EcsUser",
|
|
" | undefined; user_agent?: ",
|
|
"EcsUserAgent",
|
|
" | undefined; vulnerability?: ",
|
|
"EcsVulnerability",
|
|
" | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EcsEventCategory",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EcsEventCategory",
|
|
"description": [],
|
|
"signature": [
|
|
"\"database\" | \"email\" | \"package\" | \"network\" | \"web\" | \"file\" | \"host\" | \"session\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\""
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EcsEventKind",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EcsEventKind",
|
|
"description": [],
|
|
"signature": [
|
|
"\"metric\" | \"alert\" | \"state\" | \"event\" | \"signal\" | \"pipeline_error\""
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EcsEventOutcome",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EcsEventOutcome",
|
|
"description": [],
|
|
"signature": [
|
|
"\"success\" | \"unknown\" | \"failure\""
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EcsEventType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EcsEventType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"start\" | \"error\" | \"end\" | \"group\" | \"user\" | \"info\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\""
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ElasticsearchClient",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ElasticsearchClient",
|
|
"description": [
|
|
"\nClient used to query the elasticsearch cluster.\n"
|
|
],
|
|
"signature": [
|
|
"{ name: string | symbol; transform: ",
|
|
"default",
|
|
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params?: ",
|
|
"SearchRequest",
|
|
" | ",
|
|
"SearchRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchResponse",
|
|
"<TDocument, TAggregations>>; }; cluster: ",
|
|
"default",
|
|
"; eql: ",
|
|
"default",
|
|
"; create: { <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"CreateRequest",
|
|
"<TDocument> | ",
|
|
"CreateRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; monitoring: ",
|
|
"default",
|
|
"; security: ",
|
|
"default",
|
|
"; index: { <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"IndexRequest",
|
|
"<TDocument> | ",
|
|
"IndexRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; get: { <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetRequest",
|
|
" | ",
|
|
"GetRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetResponse",
|
|
"<TDocument>>; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"UpdateRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateResponse",
|
|
"<TDocumentR>>; }; delete: { (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"WriteResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteRequest",
|
|
" | ",
|
|
"DeleteRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"WriteResponseBase",
|
|
">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
|
|
"default",
|
|
"; helpers: ",
|
|
"default",
|
|
"; child: (opts: ",
|
|
"ClientOptions",
|
|
") => ",
|
|
"default",
|
|
"; Internal: ",
|
|
"default",
|
|
"; asyncSearch: ",
|
|
"default",
|
|
"; autoscaling: ",
|
|
"default",
|
|
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"BulkResponse",
|
|
", unknown>>; <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument> | ",
|
|
"BulkRequest",
|
|
"<TDocument, TPartialDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"BulkResponse",
|
|
">; }; cat: ",
|
|
"default",
|
|
"; ccr: ",
|
|
"default",
|
|
"; clearScroll: { (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClearScrollResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"ClearScrollRequest",
|
|
" | ",
|
|
"ClearScrollRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClearScrollResponse",
|
|
">; }; closePointInTime: { (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ClosePointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ClosePointInTimeRequest",
|
|
" | ",
|
|
"ClosePointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ClosePointInTimeResponse",
|
|
">; }; count: { (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"CountResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"CountRequest",
|
|
" | ",
|
|
"CountRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"CountResponse",
|
|
">; }; danglingIndices: ",
|
|
"default",
|
|
"; deleteByQuery: { (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"DeleteByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRequest",
|
|
" | ",
|
|
"DeleteByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"DeleteByQueryResponse",
|
|
">; }; deleteByQueryRethrottle: { (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TasksTaskListResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
" | ",
|
|
"DeleteByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TasksTaskListResponseBase",
|
|
">; }; deleteScript: { (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"DeleteScriptRequest",
|
|
" | ",
|
|
"DeleteScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; enrich: ",
|
|
"default",
|
|
"; exists: { (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsRequest",
|
|
" | ",
|
|
"ExistsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params: ",
|
|
"ExistsSourceRequest",
|
|
" | ",
|
|
"ExistsSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; explain: { <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ExplainResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"ExplainRequest",
|
|
" | ",
|
|
"ExplainRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ExplainResponse",
|
|
"<TDocument>>; }; features: ",
|
|
"default",
|
|
"; fieldCaps: { (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"FieldCapsResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"FieldCapsRequest",
|
|
" | ",
|
|
"FieldCapsRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"FieldCapsResponse",
|
|
">; }; fleet: ",
|
|
"default",
|
|
"; getScript: { (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"GetScriptRequest",
|
|
" | ",
|
|
"GetScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptResponse",
|
|
">; }; getScriptContext: { (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptContextResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptContextRequest",
|
|
" | ",
|
|
"GetScriptContextRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptContextResponse",
|
|
">; }; getScriptLanguages: { (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"GetScriptLanguagesResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"GetScriptLanguagesRequest",
|
|
" | ",
|
|
"GetScriptLanguagesRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"GetScriptLanguagesResponse",
|
|
">; }; getSource: { <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<TDocument>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<TDocument, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"GetSourceRequest",
|
|
" | ",
|
|
"GetSourceRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<TDocument>; }; graph: ",
|
|
"default",
|
|
"; ilm: ",
|
|
"default",
|
|
"; indices: ",
|
|
"default",
|
|
"; info: { (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"InfoResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"InfoRequest",
|
|
" | ",
|
|
"InfoRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"InfoResponse",
|
|
">; }; ingest: ",
|
|
"default",
|
|
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"KnnSearchRequest",
|
|
" | ",
|
|
"KnnSearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"KnnSearchResponse",
|
|
"<TDocument>>; }; license: ",
|
|
"default",
|
|
"; logstash: ",
|
|
"default",
|
|
"; mget: { <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MgetResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"MgetRequest",
|
|
" | ",
|
|
"MgetRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MgetResponse",
|
|
"<TDocument>>; }; migration: ",
|
|
"default",
|
|
"; ml: ",
|
|
"default",
|
|
"; msearch: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchRequest",
|
|
" | ",
|
|
"MsearchRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchResponse",
|
|
"<TDocument, TAggregations>>; }; msearchTemplate: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"MsearchTemplateRequest",
|
|
" | ",
|
|
"MsearchTemplateRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MsearchTemplateResponse",
|
|
"<TDocument, TAggregations>>; }; mtermvectors: { (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"MtermvectorsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"MtermvectorsRequest",
|
|
" | ",
|
|
"MtermvectorsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"MtermvectorsResponse",
|
|
">; }; nodes: ",
|
|
"default",
|
|
"; openPointInTime: { (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"OpenPointInTimeResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"OpenPointInTimeRequest",
|
|
" | ",
|
|
"OpenPointInTimeRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"OpenPointInTimeResponse",
|
|
">; }; ping: { (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<boolean>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<boolean, unknown>>; (this: That, params?: ",
|
|
"PingRequest",
|
|
" | ",
|
|
"PingRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"AcknowledgedResponseBase",
|
|
", unknown>>; (this: That, params: ",
|
|
"PutScriptRequest",
|
|
" | ",
|
|
"PutScriptRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"AcknowledgedResponseBase",
|
|
">; }; rankEval: { (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RankEvalResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"RankEvalRequest",
|
|
" | ",
|
|
"RankEvalRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RankEvalResponse",
|
|
">; }; reindex: { (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRequest",
|
|
" | ",
|
|
"ReindexRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexResponse",
|
|
">; }; reindexRethrottle: { (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ReindexRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"ReindexRethrottleRequest",
|
|
" | ",
|
|
"ReindexRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ReindexRethrottleResponse",
|
|
">; }; renderSearchTemplate: { (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"RenderSearchTemplateResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"RenderSearchTemplateRequest",
|
|
" | ",
|
|
"RenderSearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"RenderSearchTemplateResponse",
|
|
">; }; rollup: ",
|
|
"default",
|
|
"; scriptsPainlessExecute: { <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>, unknown>>; <TResult = unknown>(this: That, params?: ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | ",
|
|
"ScriptsPainlessExecuteRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScriptsPainlessExecuteResponse",
|
|
"<TResult>>; }; scroll: { <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>, unknown>>; <TDocument = unknown, TAggregations = Record<string, ",
|
|
"AggregationsAggregate",
|
|
">>(this: That, params: ",
|
|
"ScrollRequest",
|
|
" | ",
|
|
"ScrollRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"ScrollResponse",
|
|
"<TDocument, TAggregations>>; }; searchMvt: { (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<ArrayBuffer>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<ArrayBuffer, unknown>>; (this: That, params: ",
|
|
"SearchMvtRequest",
|
|
" | ",
|
|
"SearchMvtRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<ArrayBuffer>; }; searchShards: { (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchShardsResponse",
|
|
", unknown>>; (this: That, params?: ",
|
|
"SearchShardsRequest",
|
|
" | ",
|
|
"SearchShardsRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchShardsResponse",
|
|
">; }; searchTemplate: { <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params?: ",
|
|
"SearchTemplateRequest",
|
|
" | ",
|
|
"SearchTemplateRequest",
|
|
" | undefined, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"SearchTemplateResponse",
|
|
"<TDocument>>; }; searchableSnapshots: ",
|
|
"default",
|
|
"; shutdown: ",
|
|
"default",
|
|
"; slm: ",
|
|
"default",
|
|
"; snapshot: ",
|
|
"default",
|
|
"; sql: ",
|
|
"default",
|
|
"; ssl: ",
|
|
"default",
|
|
"; tasks: ",
|
|
"default",
|
|
"; termsEnum: { (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermsEnumResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"TermsEnumRequest",
|
|
" | ",
|
|
"TermsEnumRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermsEnumResponse",
|
|
">; }; termvectors: { <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"TermvectorsResponse",
|
|
", unknown>>; <TDocument = unknown>(this: That, params: ",
|
|
"TermvectorsRequest",
|
|
"<TDocument> | ",
|
|
"TermvectorsRequest",
|
|
"<TDocument>, options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"TermvectorsResponse",
|
|
">; }; textStructure: ",
|
|
"default",
|
|
"; updateByQuery: { (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRequest",
|
|
" | ",
|
|
"UpdateByQueryRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryResponse",
|
|
">; }; updateByQueryRethrottle: { (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithOutMeta",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptionsWithMeta",
|
|
" | undefined): Promise<",
|
|
"TransportResult",
|
|
"<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
", unknown>>; (this: That, params: ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
" | ",
|
|
"UpdateByQueryRethrottleRequest",
|
|
", options?: ",
|
|
"TransportRequestOptions",
|
|
" | undefined): Promise<",
|
|
"UpdateByQueryRethrottleResponse",
|
|
">; }; watcher: ",
|
|
"default",
|
|
"; xpack: ",
|
|
"default",
|
|
"; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.EventType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EventType",
|
|
"description": [
|
|
"\nEvent Type used for indexed structures. Only used to improve the readability of the types"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ExecutionContextStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExecutionContextStart",
|
|
"description": [],
|
|
"signature": [
|
|
"ExecutionContextSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ExposedToBrowserDescriptor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExposedToBrowserDescriptor",
|
|
"description": [
|
|
"\nType defining the list of configuration properties that will be exposed on the client-side\nObject properties can either be fully exposed\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof T]?: (T[Key] extends Maybe<any[]> ? boolean : T[Key] extends Maybe<object> ? boolean | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.ExposedToBrowserDescriptor",
|
|
"text": "ExposedToBrowserDescriptor"
|
|
},
|
|
"<T[Key]> : boolean) | undefined; }"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.GetAuthHeaders",
|
|
"type": "Type",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "GetAuthHeaders",
|
|
"description": [
|
|
"\nGet headers to authenticate a user against Elasticsearch."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
"AuthHeaders",
|
|
" | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [
|
|
"authentication headers {@link AuthHeaders } for - an incoming request."
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.GetAuthHeaders.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"{@link KibanaRequest } - an incoming request."
|
|
],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.GetAuthState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GetAuthState",
|
|
"description": [
|
|
"\nGets authentication state for a request. Returned by `auth` interceptor."
|
|
],
|
|
"signature": [
|
|
"<T = unknown>(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => { status: ",
|
|
"AuthStatus",
|
|
"; state: T; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.GetAuthState.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"{@link KibanaRequest } - an incoming request."
|
|
],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HandlerContextType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HandlerContextType",
|
|
"description": [
|
|
"\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n"
|
|
],
|
|
"signature": [
|
|
"T extends ",
|
|
"HandlerFunction",
|
|
"<infer U> ? U : never"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HandlerFunction",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HandlerFunction",
|
|
"description": [
|
|
"\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n"
|
|
],
|
|
"signature": [
|
|
"(context: T, ...args: any[]) => any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HandlerFunction.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HandlerFunction.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"any[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HandlerParameters",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HandlerParameters",
|
|
"description": [
|
|
"\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n"
|
|
],
|
|
"signature": [
|
|
"T extends (context: any, ...args: infer U) => any ? U : never"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.Headers",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Headers",
|
|
"description": [
|
|
"\nHttp request headers to read."
|
|
],
|
|
"signature": [
|
|
"{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesRequestHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HttpResourcesRequestHandler",
|
|
"description": [
|
|
"\nExtended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}\nto respond with HTML or JS resources."
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, \"get\">, response: ",
|
|
"KibanaSuccessResponseFactory",
|
|
" & ",
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory",
|
|
" & { custom<T extends string | Record<string, any> | Error | ",
|
|
"Stream",
|
|
" | Buffer | { message: string | Error; attributes?: ",
|
|
"ResponseErrorAttributes",
|
|
" | undefined; } | undefined>(options: ",
|
|
"CustomHttpResponseOptions",
|
|
"<T>): ",
|
|
"IKibanaResponse",
|
|
"<any>; } & ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.HttpResourcesServiceToolkit",
|
|
"text": "HttpResourcesServiceToolkit"
|
|
},
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesRequestHandler.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [
|
|
"{@link RequestHandlerContext } - the core context exposed for this request."
|
|
],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesRequestHandler.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc."
|
|
],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesRequestHandler.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [
|
|
"{@link KibanaResponseFactory } {@libk HttpResourcesServiceToolkit} - a set of helper functions used to respond to a request."
|
|
],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResourcesResponseOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HttpResourcesResponseOptions",
|
|
"description": [
|
|
"\nHTTP Resources response parameters"
|
|
],
|
|
"signature": [
|
|
"HttpResponseOptions"
|
|
],
|
|
"path": "src/core/server/http_resources/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.HttpResponsePayload",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HttpResponsePayload",
|
|
"description": [
|
|
"\nData send to the client as a response payload."
|
|
],
|
|
"signature": [
|
|
"string | Record<string, any> | ",
|
|
"Stream",
|
|
" | Buffer | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextProvider",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IContextProvider",
|
|
"description": [
|
|
"\nA function that returns a context value for a specific key of given context type.\n"
|
|
],
|
|
"signature": [
|
|
"(context: Omit<Context, ContextName>, request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => ",
|
|
"MaybePromise",
|
|
"<Awaited<Context[ContextName]>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [
|
|
"The context value associated with this key. May also return a Promise which will be resolved before\nattaching to the context object."
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextProvider.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [
|
|
"- A partial context object containing only the keys for values provided by plugin dependencies"
|
|
],
|
|
"signature": [
|
|
"{ [P in Exclude<keyof Context, ContextName>]: Context[P]; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IContextProvider.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "rest",
|
|
"description": [
|
|
"- Additional parameters provided by the service owner of this context"
|
|
],
|
|
"signature": [
|
|
"[request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, response: ",
|
|
"KibanaResponseFactory",
|
|
"]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IsAuthenticated",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IsAuthenticated",
|
|
"description": [
|
|
"\nReturns authentication status for a request."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>) => boolean"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.IsAuthenticated.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"{@link KibanaRequest } - an incoming request."
|
|
],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaExecutionContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaExecutionContext",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; child?: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaRequestRouteOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaRequestRouteOptions",
|
|
"description": [
|
|
"\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned."
|
|
],
|
|
"signature": [
|
|
"Method extends \"options\" | \"get\" ? Required<Omit<",
|
|
"RouteConfigOptions",
|
|
"<Method>, \"body\">> : Required<",
|
|
"RouteConfigOptions",
|
|
"<Method>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.kibanaResponseFactory",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "kibanaResponseFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaSuccessResponseFactory",
|
|
" & ",
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory",
|
|
" & { custom<T extends string | Record<string, any> | Error | ",
|
|
"Stream",
|
|
" | Buffer | { message: string | Error; attributes?: ",
|
|
"ResponseErrorAttributes",
|
|
" | undefined; } | undefined>(options: ",
|
|
"CustomHttpResponseOptions",
|
|
"<T>): ",
|
|
"IKibanaResponse",
|
|
"<any>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-router-server-internal/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KibanaResponseFactory",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KibanaResponseFactory",
|
|
"description": [
|
|
"\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n"
|
|
],
|
|
"signature": [
|
|
"KibanaSuccessResponseFactory",
|
|
" & ",
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory",
|
|
" & { custom<T extends string | Record<string, any> | Error | ",
|
|
"Stream",
|
|
" | Buffer | { message: string | Error; attributes?: ",
|
|
"ResponseErrorAttributes",
|
|
" | undefined; } | undefined>(options: ",
|
|
"CustomHttpResponseOptions",
|
|
"<T>): ",
|
|
"IKibanaResponse",
|
|
"<any>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.KnownHeaders",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "KnownHeaders",
|
|
"description": [
|
|
"\nSet of well-known HTTP headers."
|
|
],
|
|
"signature": [
|
|
"\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LifecycleResponseFactory",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LifecycleResponseFactory",
|
|
"description": [
|
|
"\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client."
|
|
],
|
|
"signature": [
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.LogMeta",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LogMeta",
|
|
"description": [
|
|
"\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n"
|
|
],
|
|
"signature": [
|
|
"Omit<",
|
|
"EcsBase",
|
|
", \"message\" | \"@timestamp\"> & ",
|
|
"EcsTracing",
|
|
" & { agent?: ",
|
|
"EcsAgent",
|
|
" | undefined; as?: ",
|
|
"EcsAutonomousSystem",
|
|
" | undefined; client?: ",
|
|
"EcsClient",
|
|
" | undefined; cloud?: ",
|
|
"EcsCloud",
|
|
" | undefined; container?: ",
|
|
"EcsContainer",
|
|
" | undefined; destination?: ",
|
|
"EcsDestination",
|
|
" | undefined; dns?: ",
|
|
"EcsDns",
|
|
" | undefined; error?: ",
|
|
"EcsError",
|
|
" | undefined; event?: ",
|
|
"EcsEvent",
|
|
" | undefined; file?: ",
|
|
"EcsFile",
|
|
" | undefined; group?: ",
|
|
"EcsGroup",
|
|
" | undefined; host?: ",
|
|
"EcsHost",
|
|
" | undefined; http?: ",
|
|
"EcsHttp",
|
|
" | undefined; log?: Omit<",
|
|
"EcsLog",
|
|
", \"logger\" | \"level\"> | undefined; network?: ",
|
|
"EcsNetwork",
|
|
" | undefined; observer?: ",
|
|
"EcsObserver",
|
|
" | undefined; organization?: ",
|
|
"EcsOrganization",
|
|
" | undefined; package?: ",
|
|
"EcsPackage",
|
|
" | undefined; process?: ",
|
|
"EcsProcess",
|
|
" | undefined; registry?: ",
|
|
"EcsRegistry",
|
|
" | undefined; related?: ",
|
|
"EcsRelated",
|
|
" | undefined; rule?: ",
|
|
"EcsRule",
|
|
" | undefined; server?: ",
|
|
"EcsServer",
|
|
" | undefined; service?: ",
|
|
"EcsService",
|
|
" | undefined; source?: ",
|
|
"EcsSource",
|
|
" | undefined; threat?: ",
|
|
"EcsThreat",
|
|
" | undefined; tls?: ",
|
|
"EcsTls",
|
|
" | undefined; url?: ",
|
|
"EcsUrl",
|
|
" | undefined; user?: ",
|
|
"EcsUser",
|
|
" | undefined; user_agent?: ",
|
|
"EcsUserAgent",
|
|
" | undefined; vulnerability?: ",
|
|
"EcsVulnerability",
|
|
" | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__logging/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.MakeUsageFromSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MakeUsageFromSchema",
|
|
"description": [
|
|
"\nList of configuration values that will be exposed to usage collection.\nIf parent node or actual config path is set to `true` then the actual value\nof these configs will be reoprted.\nIf parent node or actual config path is set to `false` then the config\nwill be reported as [redacted].\n"
|
|
],
|
|
"signature": [
|
|
"{ [Key in keyof T]?: (T[Key] extends Maybe<object[]> ? false : T[Key] extends Maybe<any[]> ? boolean : T[Key] extends Maybe<object> ? boolean | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.MakeUsageFromSchema",
|
|
"text": "MakeUsageFromSchema"
|
|
},
|
|
"<T[Key]> : boolean) | undefined; }"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.MetricsServiceStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MetricsServiceStart",
|
|
"description": [
|
|
"\n{@inheritdoc MetricsServiceSetup}\n"
|
|
],
|
|
"signature": [
|
|
"MetricsServiceSetup"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-metrics-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.MutatingOperationRefreshSetting",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MutatingOperationRefreshSetting",
|
|
"description": [
|
|
"\nElasticsearch Refresh setting for mutating operation"
|
|
],
|
|
"signature": [
|
|
"boolean | \"wait_for\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPostAuthHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OnPostAuthHandler",
|
|
"description": [
|
|
"\nSee {@link OnPostAuthToolkit}."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, response: ",
|
|
"LifecycleResponseFactory",
|
|
", toolkit: ",
|
|
"OnPostAuthToolkit",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"OnPostAuthNextResult",
|
|
" | Promise<",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"OnPostAuthNextResult",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPostAuthHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPostAuthHandler.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPostAuthHandler.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPostAuthToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreAuthHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OnPreAuthHandler",
|
|
"description": [
|
|
"\nSee {@link OnPreAuthToolkit}."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, response: ",
|
|
"LifecycleResponseFactory",
|
|
", toolkit: ",
|
|
"OnPreAuthToolkit",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"OnPreAuthNextResult",
|
|
" | Promise<",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"OnPreAuthNextResult",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreAuthHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreAuthHandler.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreAuthHandler.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreAuthToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OnPreResponseHandler",
|
|
"description": [
|
|
"\nSee {@link OnPreResponseToolkit}."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, preResponse: ",
|
|
"OnPreResponseInfo",
|
|
", toolkit: ",
|
|
"OnPreResponseToolkit",
|
|
") => ",
|
|
"OnPreResponseResult",
|
|
" | Promise<",
|
|
"OnPreResponseResult",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseHandler.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "preResponse",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreResponseInfo"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreResponseHandler.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreResponseToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "OnPreRoutingHandler",
|
|
"description": [
|
|
"\nSee {@link OnPreRoutingToolkit}."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>, response: ",
|
|
"LifecycleResponseFactory",
|
|
", toolkit: ",
|
|
"OnPreRoutingToolkit",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"OnPreRoutingResult",
|
|
" | Promise<",
|
|
"IKibanaResponse",
|
|
"<any> | ",
|
|
"OnPreRoutingResult",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingHandler.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRedirectionResponseFactory",
|
|
" & ",
|
|
"KibanaErrorResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.OnPreRoutingHandler.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"OnPreRoutingToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginConfigSchema",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PluginConfigSchema",
|
|
"description": [
|
|
"\nDedicated type for plugin configuration schema.\n"
|
|
],
|
|
"signature": [
|
|
"Type",
|
|
"<T>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializer",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PluginInitializer",
|
|
"description": [
|
|
"\nThe `plugin` export at the root of a plugin's `server` directory should conform\nto this interface.\n"
|
|
],
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<unknown>) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<TSetup, TStart, TPluginsSetup, TPluginsStart> | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PrebootPlugin",
|
|
"text": "PrebootPlugin"
|
|
},
|
|
"<TSetup, TPluginsSetup> | ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.AsyncPlugin",
|
|
"text": "AsyncPlugin"
|
|
},
|
|
"<TSetup, TStart, TPluginsSetup, TPluginsStart>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginInitializer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<unknown>"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginName",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PluginName",
|
|
"description": [
|
|
"\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PluginOpaqueId",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PluginOpaqueId",
|
|
"description": [],
|
|
"signature": [
|
|
"symbol"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PublicHttpServiceSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicHttpServiceSetup",
|
|
"description": [
|
|
"\nPublic version of RequestHandlerContext, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandlerContext}"
|
|
],
|
|
"signature": [
|
|
"HttpServiceSetup",
|
|
"<ContextType>"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PublicRequestHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicRequestHandler",
|
|
"description": [
|
|
"\nPublic version of RequestHandler, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandler}"
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ResponseFactory) => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PublicRequestHandler.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PublicRequestHandler.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PublicRequestHandler.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PublicRouter",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicRouter",
|
|
"description": [
|
|
"\nPublic version of IRouter, default-scoped to {@link RequestHandlerContext}\nSee [@link IRouter}"
|
|
],
|
|
"signature": [
|
|
"IRouter",
|
|
"<ContextType>"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.PublicUiSettingsParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "PublicUiSettingsParams",
|
|
"description": [
|
|
"\nA sub-set of {@link UiSettingsParams} exposed to the client-side."
|
|
],
|
|
"signature": [
|
|
"{ metric?: { type: string; name: string; } | undefined; type?: ",
|
|
"UiSettingsType",
|
|
" | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; description?: string | undefined; options?: number[] | string[] | undefined; category?: string[] | undefined; optionLabels?: Record<string, string> | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ",
|
|
"DeprecationSettings",
|
|
" | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RedirectResponseOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RedirectResponseOptions",
|
|
"description": [
|
|
"\nHTTP response parameters for redirection response"
|
|
],
|
|
"signature": [
|
|
"HttpResponseOptions",
|
|
" & { headers: { location: string; }; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RequestHandler",
|
|
"description": [
|
|
"\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`."
|
|
],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ResponseFactory) => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandler.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [
|
|
"{@link RequestHandlerContext } - the core context exposed for this request."
|
|
],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandler.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc."
|
|
],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandler.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [
|
|
"{@link KibanaResponseFactory } - a set of helper functions used to respond to a request."
|
|
],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandlerWrapper",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RequestHandlerWrapper",
|
|
"description": [
|
|
"\nType-safe wrapper for {@link RequestHandler} function."
|
|
],
|
|
"signature": [
|
|
"<P, Q, B, Context extends ",
|
|
"RequestHandlerContextBase",
|
|
" = ",
|
|
"RequestHandlerContextBase",
|
|
", Method extends ",
|
|
"RouteMethod",
|
|
" = any, ResponseFactory extends ",
|
|
"KibanaResponseFactory",
|
|
" = ",
|
|
"KibanaResponseFactory",
|
|
">(handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, Method, ResponseFactory>) => ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, Method, ResponseFactory>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandlerWrapper.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ResponseFactory) => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandlerWrapper.$1.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandlerWrapper.$1.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RequestHandlerWrapper.$1.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ResponseError",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ResponseError",
|
|
"description": [
|
|
"\nError message and optional data send to the client in case of error."
|
|
],
|
|
"signature": [
|
|
"string | Error | { message: string | Error; attributes?: ",
|
|
"ResponseErrorAttributes",
|
|
" | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ResponseErrorAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ResponseErrorAttributes",
|
|
"description": [
|
|
"\nAdditional data to provide error details."
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ResponseHeaders",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ResponseHeaders",
|
|
"description": [
|
|
"\nHttp response headers to set."
|
|
],
|
|
"signature": [
|
|
"Record<\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record<string, string | string[]>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteContentType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteContentType",
|
|
"description": [
|
|
"\nThe set of supported parseable Content-Types"
|
|
],
|
|
"signature": [
|
|
"\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteMethod",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteMethod",
|
|
"description": [
|
|
"\nThe set of common HTTP methods supported by Kibana routing."
|
|
],
|
|
"signature": [
|
|
"DestructiveRouteMethod",
|
|
" | ",
|
|
"SafeRouteMethod"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteRegistrar",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteRegistrar",
|
|
"description": [
|
|
"\nRoute handler common definition\n"
|
|
],
|
|
"signature": [
|
|
"<P, Q, B>(route: ",
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>, handler: ",
|
|
"RequestHandler",
|
|
"<P, Q, B, Context, Method, ",
|
|
"KibanaResponseFactory",
|
|
">) => void"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteRegistrar.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "route",
|
|
"description": [],
|
|
"signature": [
|
|
"RouteConfig",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteRegistrar.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handler",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: Context, request: ",
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>, response: ",
|
|
"KibanaResponseFactory",
|
|
") => ",
|
|
"IKibanaResponse",
|
|
"<any> | Promise<",
|
|
"IKibanaResponse",
|
|
"<any>>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteRegistrar.$2.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"Context"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteRegistrar.$2.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequest",
|
|
"<P, Q, B, Method>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteRegistrar.$2.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "response",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationFunction",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteValidationFunction",
|
|
"description": [
|
|
"\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n"
|
|
],
|
|
"signature": [
|
|
"(data: any, validationResult: ",
|
|
"RouteValidationResultFactory",
|
|
") => { value: T; error?: undefined; } | { value?: undefined; error: ",
|
|
"RouteValidationError",
|
|
"; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationFunction.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationFunction.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "validationResult",
|
|
"description": [],
|
|
"signature": [
|
|
"RouteValidationResultFactory"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidationSpec",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteValidationSpec",
|
|
"description": [
|
|
"\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n"
|
|
],
|
|
"signature": [
|
|
"ObjectType",
|
|
"<any> | ",
|
|
"Type",
|
|
"<T> | ",
|
|
"RouteValidationFunction",
|
|
"<T>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.RouteValidatorFullConfig",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteValidatorFullConfig",
|
|
"description": [
|
|
"\nRoute validations config and options merged into one object"
|
|
],
|
|
"signature": [
|
|
"RouteValidatorConfig",
|
|
"<P, Q, B> & ",
|
|
"RouteValidatorOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SafeRouteMethod",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SafeRouteMethod",
|
|
"description": [
|
|
"\nSet of HTTP methods not changing the state of the server."
|
|
],
|
|
"signature": [
|
|
"\"options\" | \"get\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectAttribute",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectAttribute",
|
|
"description": [
|
|
"\nType definition for a Saved Object attribute value\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectAttributeSingle",
|
|
" | ",
|
|
"SavedObjectAttributeSingle",
|
|
"[]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectAttributeSingle",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectAttributeSingle",
|
|
"description": [
|
|
"\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n"
|
|
],
|
|
"signature": [
|
|
"string | number | boolean | ",
|
|
"SavedObjectAttributes",
|
|
" | null | undefined"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsClosePointInTimeOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectsClosePointInTimeOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectsBaseOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectsCreatePointInTimeFinderOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string | string[]; filter?: any; search?: string | undefined; aggs?: Record<string, ",
|
|
"AggregationsAggregationContainer",
|
|
"> | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ",
|
|
"SortOrder",
|
|
" | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ",
|
|
"SavedObjectsFindOptionsReference",
|
|
" | ",
|
|
"SavedObjectsFindOptionsReference",
|
|
"[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map<string, string[] | undefined> | undefined; preference?: string | undefined; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsImportWarning",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectsImportWarning",
|
|
"description": [
|
|
"\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n"
|
|
],
|
|
"signature": [
|
|
"SavedObjectsImportSimpleWarning",
|
|
" | ",
|
|
"SavedObjectsImportActionRequiredWarning"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SavedObjectsNamespaceType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedObjectsNamespaceType",
|
|
"description": [
|
|
"\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n"
|
|
],
|
|
"signature": [
|
|
"\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ScopeableRequest",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ScopeableRequest",
|
|
"description": [
|
|
"\n A user credentials container.\nIt accommodates the necessary auth credentials to impersonate the current user.\n"
|
|
],
|
|
"signature": [
|
|
"FakeRequest",
|
|
" | ",
|
|
"KibanaRequest",
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatusLevel",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ServiceStatusLevel",
|
|
"description": [
|
|
"\nA convenience type that represents the union of each value in {@link ServiceStatusLevels}."
|
|
],
|
|
"signature": [
|
|
"Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.SharedGlobalConfig",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SharedGlobalConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | 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 path: Readonly<{ readonly data: string; }>; readonly savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; isLessThan: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; isEqualTo: (other: ",
|
|
"ByteSizeValue",
|
|
") => boolean; getValueInBytes: () => number; toString: (returnUnit?: ByteSizeValueUnit | undefined) => string; }>; }>; }"
|
|
],
|
|
"path": "src/core/server/plugins/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.StartServicesAccessor",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "StartServicesAccessor",
|
|
"description": [
|
|
"\nAllows plugins to get access to APIs available in start inside async handlers.\nPromise will not resolve until Core and plugin dependencies have completed `start`.\nThis should only be used inside handlers registered during `setup` that will only be executed\nafter `start` lifecycle.\n"
|
|
],
|
|
"signature": [
|
|
"() => Promise<[",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
", TPluginsStart, TStart]>"
|
|
],
|
|
"path": "src/core/server/index.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.TelemetryCounterType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TelemetryCounterType",
|
|
"description": [
|
|
"\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason."
|
|
],
|
|
"signature": [
|
|
"\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\""
|
|
],
|
|
"path": "node_modules/@types/kbn__analytics-client/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UiSettingsType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UiSettingsType",
|
|
"description": [
|
|
"\nUI element type to represent the settings."
|
|
],
|
|
"signature": [
|
|
"\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"image\" | \"json\" | \"markdown\" | \"select\" | \"array\""
|
|
],
|
|
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandler",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UnauthorizedErrorHandler",
|
|
"description": [
|
|
"\nA handler used to handle unauthorized error returned by elasticsearch\n"
|
|
],
|
|
"signature": [
|
|
"(options: ",
|
|
"UnauthorizedErrorHandlerOptions",
|
|
", toolkit: ",
|
|
"UnauthorizedErrorHandlerToolkit",
|
|
") => ",
|
|
"MaybePromise",
|
|
"<",
|
|
"UnauthorizedErrorHandlerResult",
|
|
">"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerOptions"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandler.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toolkit",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerToolkit"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.UnauthorizedErrorHandlerResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UnauthorizedErrorHandlerResult",
|
|
"description": [],
|
|
"signature": [
|
|
"UnauthorizedErrorHandlerRetryResult",
|
|
" | ",
|
|
"UnauthorizedErrorHandlerNotHandledResult"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.ServiceStatusLevels",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ServiceStatusLevels",
|
|
"description": [
|
|
"\nThe current \"level\" of availability of a service.\n"
|
|
],
|
|
"signature": [
|
|
"{ readonly available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; readonly degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; readonly unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; readonly critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-base-common/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "core",
|
|
"id": "def-server.validBodyOutput",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "validBodyOutput",
|
|
"description": [
|
|
"\nThe set of valid body.output"
|
|
],
|
|
"signature": [
|
|
"readonly [\"data\", \"stream\"]"
|
|
],
|
|
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |