maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/core_saved_objects.json
Mikhail Shustov f5e8b108da
Attempt to reduce Core bundle size with type exports. (#92221) 
* compile core files as isolated modules

* fix export problems for isolated modules

* apply changes to kbn-test as core imports from it

* fix some exports

* fix lint errors

* update new exports

* fix eslint error

* expand export * where it is possible

* update docs

* update docs

* fix eslint error
2021-03-03 17:21:49 +01:00

14001 lines
542 KiB
JSON
Raw Blame History

{
"id": "core.savedObjects",
"client": {
"classes": [
{
"id": "def-public.SimpleSavedObject",
"type": "Class",
"tags": [
"public"
],
"label": "SimpleSavedObject",
"description": [
"\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClient}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>"
],
"children": [
{
"tags": [],
"id": "def-public.SimpleSavedObject.attributes",
"type": "Uncategorized",
"label": "attributes",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L24"
},
"signature": [
"T"
]
},
{
"tags": [],
"id": "def-public.SimpleSavedObject._version",
"type": "string",
"label": "_version",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L26"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SimpleSavedObject.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L27"
}
},
{
"tags": [],
"id": "def-public.SimpleSavedObject.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L28"
}
},
{
"tags": [],
"id": "def-public.SimpleSavedObject.migrationVersion",
"type": "Object",
"label": "migrationVersion",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L29"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectsMigrationVersion",
"text": "SavedObjectsMigrationVersion"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SimpleSavedObject.coreMigrationVersion",
"type": "string",
"label": "coreMigrationVersion",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L30"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SimpleSavedObject.error",
"type": "Object",
"label": "error",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L31"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectError",
"text": "SavedObjectError"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SimpleSavedObject.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L32"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]"
]
},
{
"id": "def-public.SimpleSavedObject.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "client",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L35"
}
},
{
"type": "Object",
"label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L36"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L34"
}
},
{
"id": "def-public.SimpleSavedObject.get",
"type": "Function",
"label": "get",
"signature": [
"(key: string) => any"
],
"description": [],
"children": [
{
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59"
}
},
{
"id": "def-public.SimpleSavedObject.set",
"type": "Function",
"label": "set",
"signature": [
"(key: string, value: any) => T"
],
"description": [],
"children": [
{
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63"
}
},
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63"
}
},
{
"id": "def-public.SimpleSavedObject.has",
"type": "Function",
"label": "has",
"signature": [
"(key: string) => boolean"
],
"description": [],
"children": [
{
"type": "string",
"label": "key",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67"
}
},
{
"id": "def-public.SimpleSavedObject.save",
"type": "Function",
"label": "save",
"signature": [
"() => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L71"
}
},
{
"id": "def-public.SimpleSavedObject.delete",
"type": "Function",
"label": "delete",
"signature": [
"() => Promise<{}>"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 86,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L86"
}
}
],
"source": {
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L23"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsClient",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsClient",
"description": [
"\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state. The client-side\nSavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n"
],
"children": [
{
"id": "def-public.SavedObjectsClient.create",
"type": "Function",
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 221,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L221"
}
},
{
"type": "Uncategorized",
"label": "attributes",
"isRequired": true,
"signature": [
"T"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 222,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L222"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 223,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L223"
}
}
],
"signature": [
"<T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>"
],
"description": [
"\nPersists an object\n"
],
"label": "create",
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 220,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L220"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.SavedObjectsClient.bulkCreate",
"type": "Function",
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<unknown>[]"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 256,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L256"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkCreateOptions",
"text": "SavedObjectsBulkCreateOptions"
}
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 257,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L257"
}
}
],
"signature": [
"(objects?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<unknown>[], options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkCreateOptions",
"text": "SavedObjectsBulkCreateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<unknown>>"
],
"description": [
"\nCreates multiple documents at once\n"
],
"label": "bulkCreate",
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 255,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L255"
},
"tags": [
"property"
],
"returnComment": [
"The result of the create operation containing created saved objects."
]
},
{
"id": "def-public.SavedObjectsClient.delete",
"type": "Function",
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 284,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L284"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 285,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L285"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 286,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L286"
}
}
],
"signature": [
"(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
" | undefined) => Promise<{}>"
],
"description": [
"\nDeletes an object\n"
],
"label": "delete",
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 283,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L283"
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.SavedObjectsClient.find",
"type": "Function",
"children": [
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 314,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L314"
}
}
],
"signature": [
"<T = unknown>(options: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsFindResponsePublic",
"text": "SavedObjectsFindResponsePublic"
},
"<T>>"
],
"description": [
"\nSearch for objects\n"
],
"label": "find",
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 313,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L313"
},
"tags": [
"property",
"property",
"property",
"property",
"property",
"property",
"property"
],
"returnComment": [
"A find result with objects matching the specified search."
]
},
{
"id": "def-public.SavedObjectsClient.get",
"type": "Function",
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 372,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 372,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372"
}
}
],
"signature": [
"<T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>"
],
"description": [
"\nFetches a single object\n"
],
"label": "get",
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 372,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372"
},
"tags": [],
"returnComment": [
"The saved object for the given type and id."
]
},
{
"id": "def-public.SavedObjectsClient.bulkGet",
"type": "Function",
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
"{ id: string; type: string; }[]"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 395,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395"
}
}
],
"signature": [
"(objects?: { id: string; type: string; }[]) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<unknown>>"
],
"description": [
"\nReturns an array of objects by id\n"
],
"label": "bulkGet",
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 395,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395"
},
"tags": [
"example"
],
"returnComment": [
"The saved objects with the given type and ids requested"
]
},
{
"id": "def-public.SavedObjectsClient.update",
"type": "Function",
"label": "update",
"signature": [
"<T = unknown>(type: string, id: string, attributes: T, { version, migrationVersion, references }?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>"
],
"description": [
"\nUpdates an object\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 427,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L427"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 428,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L428"
}
},
{
"type": "Uncategorized",
"label": "attributes",
"isRequired": true,
"signature": [
"T"
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 429,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L429"
}
},
{
"type": "Object",
"label": "{ version, migrationVersion, references }",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
}
],
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 430,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L430"
}
}
],
"tags": [
"prop",
"prop"
],
"returnComment": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 426,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L426"
}
},
{
"id": "def-public.SavedObjectsClient.bulkUpdate",
"type": "Function",
"label": "bulkUpdate",
"signature": [
"<T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<unknown>[]) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<unknown>>"
],
"description": [
"\nUpdate multiple documents at once\n"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<unknown>[]"
],
"description": [
"- [{ type, id, attributes, options: { version, references } }]"
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 458,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458"
}
}
],
"tags": [],
"returnComment": [
"The result of the update operation containing both failed and updated saved objects."
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 458,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458"
}
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 165,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L165"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-public.SavedObjectsBatchResponse",
"type": "Interface",
"label": "SavedObjectsBatchResponse",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<T>"
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsBatchResponse.savedObjects",
"type": "Array",
"label": "savedObjects",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L89"
},
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>[]"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L88"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsBulkCreateObject",
"type": "Interface",
"label": "SavedObjectsBulkCreateObject",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T> extends ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsBulkCreateObject.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L55"
}
},
{
"tags": [],
"id": "def-public.SavedObjectsBulkCreateObject.attributes",
"type": "Uncategorized",
"label": "attributes",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 56,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L56"
},
"signature": [
"T"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L54"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsBulkCreateOptions",
"type": "Interface",
"label": "SavedObjectsBulkCreateOptions",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsBulkCreateOptions.overwrite",
"type": "CompoundType",
"label": "overwrite",
"description": [
"If a document with the given `id` already exists, overwrite it's contents (default=false)."
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 62,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L62"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L60"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsBulkUpdateObject",
"type": "Interface",
"label": "SavedObjectsBulkUpdateObject",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>"
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsBulkUpdateObject.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L67"
}
},
{
"tags": [],
"id": "def-public.SavedObjectsBulkUpdateObject.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 68,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L68"
}
},
{
"tags": [],
"id": "def-public.SavedObjectsBulkUpdateObject.attributes",
"type": "Uncategorized",
"label": "attributes",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L69"
},
"signature": [
"T"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsBulkUpdateObject.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 70,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L70"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsBulkUpdateObject.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L71"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L66"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsBulkUpdateOptions",
"type": "Interface",
"label": "SavedObjectsBulkUpdateOptions",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsBulkUpdateOptions.namespace",
"type": "string",
"label": "namespace",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 76,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L76"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L75"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsCreateOptions",
"type": "Interface",
"label": "SavedObjectsCreateOptions",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsCreateOptions.id",
"type": "string",
"label": "id",
"description": [
"\n(Not recommended) Specify an id instead of having the saved objects service generate one for you."
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L38"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsCreateOptions.overwrite",
"type": "CompoundType",
"label": "overwrite",
"description": [
"If a document with the given `id` already exists, overwrite it's contents (default=false)."
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L40"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsCreateOptions.migrationVersion",
"type": "Object",
"label": "migrationVersion",
"description": [
"{@inheritDoc SavedObjectsMigrationVersion}"
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L42"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectsMigrationVersion",
"text": "SavedObjectsMigrationVersion"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion",
"type": "string",
"label": "coreMigrationVersion",
"description": [
"A semver value that is used when upgrading objects between Kibana versions."
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L44"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsCreateOptions.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L45"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L34"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsFindResponsePublic",
"type": "Interface",
"label": "SavedObjectsFindResponsePublic",
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsFindResponsePublic",
"text": "SavedObjectsFindResponsePublic"
},
"<T> extends ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<T>"
],
"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"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsFindResponsePublic.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 107,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L107"
}
},
{
"tags": [],
"id": "def-public.SavedObjectsFindResponsePublic.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 108,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L108"
}
},
{
"tags": [],
"id": "def-public.SavedObjectsFindResponsePublic.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 109,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L109"
}
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 106,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L106"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsUpdateOptions",
"type": "Interface",
"label": "SavedObjectsUpdateOptions",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsUpdateOptions.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L81"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsUpdateOptions.migrationVersion",
"type": "Object",
"label": "migrationVersion",
"description": [
"{@inheritDoc SavedObjectsMigrationVersion}"
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 83,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L83"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectsMigrationVersion",
"text": "SavedObjectsMigrationVersion"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsUpdateOptions.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 84,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L84"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L80"
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsStart",
"type": "Interface",
"label": "SavedObjectsStart",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsStart.client",
"type": "Object",
"label": "client",
"description": [
"{@link SavedObjectsClient}"
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_service.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_service.ts#L18"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"
]
}
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_service.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_service.ts#L16"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.SavedObjectsClientContract",
"type": "Type",
"label": "SavedObjectsClientContract",
"tags": [
"public"
],
"description": [
"\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n"
],
"source": {
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"lineNumber": 138,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L138"
},
"signature": [
"{ get: <T>(type: string, id: string) => Promise<SimpleSavedObject<T>>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => Promise<{}>; create: <T>(type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise<SimpleSavedObject<T>>; find: <T>(options: Pick<SavedObjectFindOptionsServer, \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<SavedObjectsFindResponsePublic<T>>; update: <T = unknown>(type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions) => Promise<SimpleSavedObject<T>>; bulkCreate: (objects?: SavedObjectsBulkCreateObject<unknown>[], options?: SavedObjectsBulkCreateOptions) => Promise<SavedObjectsBatchResponse<unknown>>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<SavedObjectsBatchResponse<unknown>>; bulkUpdate: <T>(objects?: SavedObjectsBulkUpdateObject<unknown>[]) => Promise<SavedObjectsBatchResponse<unknown>>; }"
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [
{
"id": "def-server.SavedObjectsClient",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsClient",
"description": [
"\n"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsClient.errors",
"type": "Object",
"label": "errors",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 397,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L397"
},
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
}
]
},
{
"tags": [],
"id": "def-server.SavedObjectsClient.errors",
"type": "Object",
"label": "errors",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 398,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L398"
},
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
}
]
},
{
"id": "def-server.SavedObjectsClient.create",
"type": "Function",
"label": "create",
"signature": [
"<T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>"
],
"description": [
"\nPersists a SavedObject\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 414,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"
}
},
{
"type": "Uncategorized",
"label": "attributes",
"isRequired": true,
"signature": [
"T"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 414,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 414,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 414,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"
}
},
{
"id": "def-server.SavedObjectsClient.bulkCreate",
"type": "Function",
"label": "bulkCreate",
"signature": [
"<T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>"
],
"description": [
"\nPersists multiple documents batched together as a single request\n"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 425,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L425"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 426,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L426"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 424,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L424"
}
},
{
"id": "def-server.SavedObjectsClient.checkConflicts",
"type": "Function",
"label": "checkConflicts",
"signature": [
"(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">"
],
"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"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 439,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L439"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 440,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L440"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 438,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L438"
}
},
{
"id": "def-server.SavedObjectsClient.delete",
"type": "Function",
"label": "delete",
"signature": [
"(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>"
],
"description": [
"\nDeletes a SavedObject\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 452,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 452,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 452,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 452,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"
}
},
{
"id": "def-server.SavedObjectsClient.find",
"type": "Function",
"label": "find",
"signature": [
"<T = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T>>"
],
"description": [
"\nFind all SavedObjects matching the search query\n"
],
"children": [
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 461,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L461"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 461,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L461"
}
},
{
"id": "def-server.SavedObjectsClient.bulkGet",
"type": "Function",
"label": "bulkGet",
"signature": [
"<T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>"
],
"description": [
"\nReturns an array of objects by id\n"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[]"
],
"description": [
"- an array of ids, or an array of objects containing id, type and optionally fields"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 477,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L477"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 478,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L478"
}
}
],
"tags": [
"example"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 476,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L476"
}
},
{
"id": "def-server.SavedObjectsClient.get",
"type": "Function",
"label": "get",
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>"
],
"description": [
"\nRetrieves a single object\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The type of SavedObject to retrieve"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 491,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L491"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The ID of the SavedObject to retrieve"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 492,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L492"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 493,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L493"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 490,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L490"
}
},
{
"id": "def-server.SavedObjectsClient.resolve",
"type": "Function",
"label": "resolve",
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>"
],
"description": [
"\nResolves a single object, using any legacy URL alias if it exists\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The type of SavedObject to retrieve"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 506,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L506"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The ID of the SavedObject to retrieve"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 507,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L507"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 508,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L508"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 505,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L505"
}
},
{
"id": "def-server.SavedObjectsClient.update",
"type": "Function",
"label": "update",
"signature": [
"<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>"
],
"description": [
"\nUpdates an SavedObject\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 521,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L521"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 522,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L522"
}
},
{
"type": "Object",
"label": "attributes",
"isRequired": true,
"signature": [
"Partial<T>"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 523,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L523"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 524,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L524"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 520,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L520"
}
},
{
"id": "def-server.SavedObjectsClient.addToNamespaces",
"type": "Function",
"label": "addToNamespaces",
"signature": [
"(type: string, id: string, namespaces: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsAddToNamespacesOptions",
"text": "SavedObjectsAddToNamespacesOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsAddToNamespacesResponse",
"text": "SavedObjectsAddToNamespacesResponse"
},
">"
],
"description": [
"\nAdds namespaces to a SavedObject\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 538,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L538"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 539,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L539"
}
},
{
"type": "Array",
"label": "namespaces",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 540,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L540"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsAddToNamespacesOptions",
"text": "SavedObjectsAddToNamespacesOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 541,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L541"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 537,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L537"
}
},
{
"id": "def-server.SavedObjectsClient.deleteFromNamespaces",
"type": "Function",
"label": "deleteFromNamespaces",
"signature": [
"(type: string, id: string, namespaces: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteFromNamespacesOptions",
"text": "SavedObjectsDeleteFromNamespacesOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteFromNamespacesResponse",
"text": "SavedObjectsDeleteFromNamespacesResponse"
},
">"
],
"description": [
"\nRemoves namespaces from a SavedObject\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 555,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L555"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 556,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L556"
}
},
{
"type": "Array",
"label": "namespaces",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 557,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L557"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteFromNamespacesOptions",
"text": "SavedObjectsDeleteFromNamespacesOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 558,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L558"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 554,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L554"
}
},
{
"id": "def-server.SavedObjectsClient.bulkUpdate",
"type": "Function",
"label": "bulkUpdate",
"signature": [
"<T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>"
],
"description": [
"\nBulk Updates multiple SavedObject at once\n"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 569,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L569"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 570,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L570"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 568,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L568"
}
},
{
"id": "def-server.SavedObjectsClient.removeReferencesTo",
"type": "Function",
"label": "removeReferencesTo",
"signature": [
"(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">"
],
"description": [
"\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference."
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 579,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L579"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 580,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L580"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 581,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L581"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 578,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L578"
}
},
{
"id": "def-server.SavedObjectsClient.openPointInTimeForType",
"type": "Function",
"label": "openPointInTimeForType",
"signature": [
"(type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">"
],
"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."
],
"children": [
{
"type": "CompoundType",
"label": "type",
"isRequired": true,
"signature": [
"string | string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 592,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L592"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 593,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L593"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 591,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L591"
}
},
{
"id": "def-server.SavedObjectsClient.closePointInTime",
"type": "Function",
"label": "closePointInTime",
"signature": [
"(id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">"
],
"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}."
],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 603,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 603,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 603,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 396,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L396"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsErrorHelpers",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsErrorHelpers",
"description": [],
"children": [
{
"id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError",
"type": "Function",
"label": "isSavedObjectsClientError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isSavedObjectsClientError"
],
"description": [],
"children": [
{
"type": "Any",
"label": "error",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L73"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L73"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError",
"type": "Function",
"label": "decorateBadRequestError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateBadRequestError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.createBadRequestError",
"type": "Function",
"label": "createBadRequestError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".createBadRequestError"
],
"description": [],
"children": [
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L81"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L81"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError",
"type": "Function",
"label": "createUnsupportedTypeError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".createUnsupportedTypeError"
],
"description": [],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L85"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L85"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isBadRequestError",
"type": "Function",
"label": "isBadRequestError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isBadRequestError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L92"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L92"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError",
"type": "Function",
"label": "createInvalidVersionError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".createInvalidVersionError"
],
"description": [],
"children": [
{
"type": "string",
"label": "versionInput",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 96,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L96"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 96,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L96"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError",
"type": "Function",
"label": "isInvalidVersionError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isInvalidVersionError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 104,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L104"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 104,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L104"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError",
"type": "Function",
"label": "decorateNotAuthorizedError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateNotAuthorizedError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 108,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 108,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 108,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError",
"type": "Function",
"label": "isNotAuthorizedError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isNotAuthorizedError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 112,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L112"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 112,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L112"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError",
"type": "Function",
"label": "decorateForbiddenError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateForbiddenError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 116,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 116,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 116,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isForbiddenError",
"type": "Function",
"label": "isForbiddenError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isForbiddenError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 120,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L120"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 120,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L120"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError",
"type": "Function",
"label": "decorateRequestEntityTooLargeError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateRequestEntityTooLargeError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 124,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 124,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 124,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError",
"type": "Function",
"label": "isRequestEntityTooLargeError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isRequestEntityTooLargeError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 127,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L127"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 127,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L127"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError",
"type": "Function",
"label": "createGenericNotFoundError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".createGenericNotFoundError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "type",
"isRequired": false,
"signature": [
"string | null"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 131,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131"
}
},
{
"type": "CompoundType",
"label": "id",
"isRequired": false,
"signature": [
"string | null"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 131,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 131,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError",
"type": "Function",
"label": "createIndexAliasNotFoundError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".createIndexAliasNotFoundError"
],
"description": [],
"children": [
{
"type": "string",
"label": "alias",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 138,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L138"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 138,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L138"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError",
"type": "Function",
"label": "decorateIndexAliasNotFoundError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateIndexAliasNotFoundError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 142,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142"
}
},
{
"type": "string",
"label": "alias",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 142,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 142,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isNotFoundError",
"type": "Function",
"label": "isNotFoundError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isNotFoundError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 151,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L151"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 151,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L151"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateConflictError",
"type": "Function",
"label": "decorateConflictError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateConflictError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.createConflictError",
"type": "Function",
"label": "createConflictError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".createConflictError"
],
"description": [],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 159,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 159,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 159,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 159,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isConflictError",
"type": "Function",
"label": "isConflictError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isConflictError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 166,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L166"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 166,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L166"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError",
"type": "Function",
"label": "decorateTooManyRequestsError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateTooManyRequestsError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 170,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 170,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 170,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError",
"type": "Function",
"label": "createTooManyRequestsError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".createTooManyRequestsError"
],
"description": [],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 174,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 174,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 174,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError",
"type": "Function",
"label": "isTooManyRequestsError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isTooManyRequestsError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 178,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L178"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 178,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L178"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError",
"type": "Function",
"label": "decorateEsCannotExecuteScriptError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateEsCannotExecuteScriptError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 182,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 182,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 182,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError",
"type": "Function",
"label": "isEsCannotExecuteScriptError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isEsCannotExecuteScriptError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 186,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L186"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 186,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L186"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError",
"type": "Function",
"label": "decorateEsUnavailableError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateEsUnavailableError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 190,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 190,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 190,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError",
"type": "Function",
"label": "isEsUnavailableError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isEsUnavailableError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 194,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L194"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 194,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L194"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError",
"type": "Function",
"label": "decorateGeneralError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".decorateGeneralError"
],
"description": [],
"children": [
{
"type": "Object",
"label": "error",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 198,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198"
}
},
{
"type": "string",
"label": "reason",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 198,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 198,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198"
}
},
{
"id": "def-server.SavedObjectsErrorHelpers.isGeneralError",
"type": "Function",
"label": "isGeneralError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
".isGeneralError"
],
"description": [],
"children": [
{
"type": "CompoundType",
"label": "error",
"isRequired": true,
"signature": [
"Error | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.DecoratedError",
"text": "DecoratedError"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 202,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L202"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 202,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L202"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"lineNumber": 72,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L72"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsSerializer",
"type": "Class",
"tags": [
"remarks",
"public"
],
"label": "SavedObjectsSerializer",
"description": [
"\nA serializer that can be used to manually convert {@link SavedObjectsRawDoc | raw} or\n{@link SavedObjectSanitizedDoc | sanitized} documents to the other kind.\n"
],
"children": [
{
"id": "def-server.SavedObjectsSerializer.isRawSavedObject",
"type": "Function",
"label": "isRawSavedObject",
"signature": [
"(doc: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDoc",
"text": "SavedObjectsRawDoc"
},
", options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDocParseOptions",
"text": "SavedObjectsRawDocParseOptions"
},
") => boolean"
],
"description": [
"\nDetermines whether or not the raw document can be converted to a saved object.\n"
],
"children": [
{
"type": "Object",
"label": "doc",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDoc",
"text": "SavedObjectsRawDoc"
}
],
"description": [
"- The raw ES document to be tested"
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDocParseOptions",
"text": "SavedObjectsRawDocParseOptions"
}
],
"description": [
"- Options for parsing the raw document."
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41"
}
},
{
"id": "def-server.SavedObjectsSerializer.rawToSavedObject",
"type": "Function",
"label": "rawToSavedObject",
"signature": [
"(doc: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDoc",
"text": "SavedObjectsRawDoc"
},
", options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDocParseOptions",
"text": "SavedObjectsRawDocParseOptions"
},
") => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectSanitizedDoc",
"text": "SavedObjectSanitizedDoc"
},
"<unknown>"
],
"description": [
"\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n"
],
"children": [
{
"type": "Object",
"label": "doc",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDoc",
"text": "SavedObjectsRawDoc"
}
],
"description": [
"- The raw ES document to be converted to saved object format."
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L59"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDocParseOptions",
"text": "SavedObjectsRawDocParseOptions"
}
],
"description": [
"- Options for parsing the raw document."
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L60"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L58"
}
},
{
"id": "def-server.SavedObjectsSerializer.savedObjectToRaw",
"type": "Function",
"label": "savedObjectToRaw",
"signature": [
"(savedObj: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectSanitizedDoc",
"text": "SavedObjectSanitizedDoc"
},
"<unknown>) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDoc",
"text": "SavedObjectsRawDoc"
}
],
"description": [
"\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n"
],
"children": [
{
"type": "CompoundType",
"label": "savedObj",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectSanitizedDoc",
"text": "SavedObjectSanitizedDoc"
},
"<unknown>"
],
"description": [
"- The saved object to be converted to raw ES format."
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 102,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L102"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 102,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L102"
}
},
{
"id": "def-server.SavedObjectsSerializer.generateRawId",
"type": "Function",
"label": "generateRawId",
"signature": [
"(namespace: string | undefined, type: string, id: string) => string"
],
"description": [
"\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n"
],
"children": [
{
"type": "string",
"label": "namespace",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [
"- The namespace of the saved object"
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 143,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"
}
},
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The saved object type"
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 143,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The id of the saved object"
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 143,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 143,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"
}
},
{
"id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId",
"type": "Function",
"label": "generateRawLegacyUrlAliasId",
"signature": [
"(namespace: string, type: string, id: string) => string"
],
"description": [
"\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n"
],
"children": [
{
"type": "string",
"label": "namespace",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The namespace of the saved object"
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 156,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"
}
},
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The saved object type"
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 156,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The id of the saved object"
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 156,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 156,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"
}
}
],
"source": {
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L26"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectTypeRegistry",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectTypeRegistry",
"description": [
"\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n"
],
"children": [
{
"id": "def-server.SavedObjectTypeRegistry.registerType",
"type": "Function",
"label": "registerType",
"signature": [
"(type: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
") => void"
],
"description": [
"\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error."
],
"children": [
{
"type": "Object",
"label": "type",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.getType",
"type": "Function",
"label": "getType",
"signature": [
"(type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
" | undefined"
],
"description": [
"\nReturn the {@link SavedObjectsType | type} definition for given type name."
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.getVisibleTypes",
"type": "Function",
"label": "getVisibleTypes",
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"[]"
],
"description": [
"\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L51"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.getAllTypes",
"type": "Function",
"label": "getAllTypes",
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"[]"
],
"description": [
"\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L60"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes",
"type": "Function",
"label": "getImportableAndExportableTypes",
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"[]"
],
"description": [
"\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L67"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic",
"type": "Function",
"label": "isNamespaceAgnostic",
"signature": [
"(type: string) => boolean"
],
"description": [
"\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.isSingleNamespace",
"type": "Function",
"label": "isSingleNamespace",
"signature": [
"(type: string) => boolean"
],
"description": [
"\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 83,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 83,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.isMultiNamespace",
"type": "Function",
"label": "isMultiNamespace",
"signature": [
"(type: string) => boolean"
],
"description": [
"\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.isShareable",
"type": "Function",
"label": "isShareable",
"signature": [
"(type: string) => boolean"
],
"description": [
"\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.isHidden",
"type": "Function",
"label": "isHidden",
"signature": [
"(type: string) => boolean"
],
"description": [
"\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered."
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 109,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 109,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.getIndex",
"type": "Function",
"label": "getIndex",
"signature": [
"(type: string) => string | undefined"
],
"description": [
"\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered."
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 117,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 117,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117"
}
},
{
"id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable",
"type": "Function",
"label": "isImportableAndExportable",
"signature": [
"(type: string) => boolean"
],
"description": [
"\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section."
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 125,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 125,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125"
}
}
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L24"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsUtils",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsUtils",
"description": [],
"children": [
{
"id": "def-server.SavedObjectsUtils.namespaceIdToString",
"type": "Function",
"children": [
{
"type": "string",
"label": "namespace",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29"
}
}
],
"signature": [
"(namespace?: string | undefined) => string"
],
"description": [
"\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n"
],
"label": "namespaceIdToString",
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29"
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.SavedObjectsUtils.namespaceStringToId",
"type": "Function",
"children": [
{
"type": "string",
"label": "namespace",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43"
}
}
],
"signature": [
"(namespace: string) => string | undefined"
],
"description": [
"\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n"
],
"label": "namespaceStringToId",
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43"
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.SavedObjectsUtils.createEmptyFindResponse",
"type": "Function",
"children": [
{
"type": "Object",
"label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54"
}
}
],
"signature": [
"<T>({ page, perPage, }: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T>"
],
"description": [
"\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers."
],
"label": "createEmptyFindResponse",
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54"
},
"tags": [],
"returnComment": []
},
{
"id": "def-server.SavedObjectsUtils.generateId",
"type": "Function",
"label": "generateId",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUtils",
"text": "SavedObjectsUtils"
},
".generateId"
],
"description": [
"\nGenerates a random ID for a saved objects."
],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L67"
}
},
{
"id": "def-server.SavedObjectsUtils.isRandomId",
"type": "Function",
"label": "isRandomId",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUtils",
"text": "SavedObjectsUtils"
},
".isRandomId"
],
"description": [
"\nValidates that a saved object ID has been randomly generated.\n"
],
"children": [
{
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [
"The ID of a saved object."
],
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77"
}
}
],
"tags": [
"todo"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L22"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsRepository",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsRepository",
"description": [],
"children": [
{
"id": "def-server.SavedObjectsRepository.create",
"type": "Function",
"label": "create",
"signature": [
"<T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>"
],
"description": [
"\nPersists an object\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 237,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L237"
}
},
{
"type": "Uncategorized",
"label": "attributes",
"isRequired": true,
"signature": [
"T"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 238,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L238"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 239,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L239"
}
}
],
"tags": [
"property",
"property",
"property",
"property",
"property"
],
"returnComment": [
"- { id, type, version, attributes }"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 236,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L236"
}
},
{
"id": "def-server.SavedObjectsRepository.bulkCreate",
"type": "Function",
"label": "bulkCreate",
"signature": [
"<T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>"
],
"description": [
"\nCreates multiple documents at once\n"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[]"
],
"description": [
"- [{ type, id, attributes, references, migrationVersion }]"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 330,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L330"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 331,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L331"
}
}
],
"tags": [
"property",
"property"
],
"returnComment": [
"- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 329,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L329"
}
},
{
"id": "def-server.SavedObjectsRepository.checkConflicts",
"type": "Function",
"label": "checkConflicts",
"signature": [
"(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">"
],
"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."
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 517,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L517"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 518,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L518"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 516,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L516"
}
},
{
"id": "def-server.SavedObjectsRepository.delete",
"type": "Function",
"label": "delete",
"signature": [
"(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>"
],
"description": [
"\nDeletes an object\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 602,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 602,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 602,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"
}
}
],
"tags": [
"property"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 602,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"
}
},
{
"id": "def-server.SavedObjectsRepository.deleteByNamespace",
"type": "Function",
"label": "deleteByNamespace",
"signature": [
"(namespace: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteByNamespaceOptions",
"text": "SavedObjectsDeleteByNamespaceOptions"
},
") => Promise<any>"
],
"description": [
"\nDeletes all objects from the provided namespace.\n"
],
"children": [
{
"type": "string",
"label": "namespace",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 664,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L664"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteByNamespaceOptions",
"text": "SavedObjectsDeleteByNamespaceOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 665,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L665"
}
}
],
"tags": [],
"returnComment": [
"- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 663,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L663"
}
},
{
"id": "def-server.SavedObjectsRepository.find",
"type": "Function",
"label": "find",
"signature": [
"<T = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T>>"
],
"description": [],
"children": [
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 725,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725"
}
}
],
"tags": [
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property"
],
"returnComment": [
"- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 725,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725"
}
},
{
"id": "def-server.SavedObjectsRepository.bulkGet",
"type": "Function",
"label": "bulkGet",
"signature": [
"<T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>"
],
"description": [
"\nReturns an array of objects by id\n"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[]"
],
"description": [
"- an array of objects containing id, type and optionally fields"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 875,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L875"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 876,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L876"
}
}
],
"tags": [
"property",
"example"
],
"returnComment": [
"- { saved_objects: [{ id, type, version, attributes }] }"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 874,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L874"
}
},
{
"id": "def-server.SavedObjectsRepository.get",
"type": "Function",
"label": "get",
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>"
],
"description": [
"\nGets a single object\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 960,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L960"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 961,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L961"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 962,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L962"
}
}
],
"tags": [
"property"
],
"returnComment": [
"- { id, type, version, attributes }"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 959,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L959"
}
},
{
"id": "def-server.SavedObjectsRepository.resolve",
"type": "Function",
"label": "resolve",
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>"
],
"description": [
"\nResolves a single object, using any legacy URL alias if it exists\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 998,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L998"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 999,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L999"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1000,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1000"
}
}
],
"tags": [
"property"
],
"returnComment": [
"- { saved_object, outcome }"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 997,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L997"
}
},
{
"id": "def-server.SavedObjectsRepository.update",
"type": "Function",
"label": "update",
"signature": [
"<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>"
],
"description": [
"\nUpdates an object\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1117,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1117"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1118,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1118"
}
},
{
"type": "Object",
"label": "attributes",
"isRequired": true,
"signature": [
"Partial<T>"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1119,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1119"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1120,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1120"
}
}
],
"tags": [
"property",
"property",
"property"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1116,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1116"
}
},
{
"id": "def-server.SavedObjectsRepository.addToNamespaces",
"type": "Function",
"label": "addToNamespaces",
"signature": [
"(type: string, id: string, namespaces: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsAddToNamespacesOptions",
"text": "SavedObjectsAddToNamespacesOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsAddToNamespacesResponse",
"text": "SavedObjectsAddToNamespacesResponse"
},
">"
],
"description": [
"\nAdds one or more namespaces to a given multi-namespace saved object. This method and\n[`deleteFromNamespaces`]{@link SavedObjectsRepository.deleteFromNamespaces} are the only ways to change which Spaces a multi-namespace\nsaved object is shared to."
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1190,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1190"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1191,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1191"
}
},
{
"type": "Array",
"label": "namespaces",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1192,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1192"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsAddToNamespacesOptions",
"text": "SavedObjectsAddToNamespacesOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1193,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1193"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1189,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1189"
}
},
{
"id": "def-server.SavedObjectsRepository.deleteFromNamespaces",
"type": "Function",
"label": "deleteFromNamespaces",
"signature": [
"(type: string, id: string, namespaces: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteFromNamespacesOptions",
"text": "SavedObjectsDeleteFromNamespacesOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteFromNamespacesResponse",
"text": "SavedObjectsDeleteFromNamespacesResponse"
},
">"
],
"description": [
"\nRemoves one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted\nentirely. This method and [`addToNamespaces`]{@link SavedObjectsRepository.addToNamespaces} are the only ways to change which Spaces a\nmulti-namespace saved object is shared to."
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1253,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1253"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1254,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1254"
}
},
{
"type": "Array",
"label": "namespaces",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1255,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1255"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteFromNamespacesOptions",
"text": "SavedObjectsDeleteFromNamespacesOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1256,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1256"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1252,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1252"
}
},
{
"id": "def-server.SavedObjectsRepository.bulkUpdate",
"type": "Function",
"label": "bulkUpdate",
"signature": [
"<T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>"
],
"description": [
"\nUpdates multiple objects in bulk\n"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[]"
],
"description": [
"- [{ type, id, attributes, options: { version, namespace } references }]"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1358,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1358"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1359,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1359"
}
}
],
"tags": [
"property",
"property"
],
"returnComment": [
"- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1357,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1357"
}
},
{
"id": "def-server.SavedObjectsRepository.removeReferencesTo",
"type": "Function",
"label": "removeReferencesTo",
"signature": [
"(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">"
],
"description": [
"\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1573,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1573"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1574,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1574"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1575,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1575"
}
}
],
"tags": [
"remarks"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1572,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1572"
}
},
{
"id": "def-server.SavedObjectsRepository.incrementCounter",
"type": "Function",
"label": "incrementCounter",
"signature": [
"<T = unknown>(type: string, id: string, counterFields: (string | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterField",
"text": "SavedObjectsIncrementCounterField"
},
")[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterOptions",
"text": "SavedObjectsIncrementCounterOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>"
],
"description": [
"\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n"
],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The type of saved object whose fields should be incremented"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1670,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1670"
}
},
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- The id of the document whose fields should be incremented"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1671,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1671"
}
},
{
"type": "Array",
"label": "counterFields",
"isRequired": true,
"signature": [
"(string | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterField",
"text": "SavedObjectsIncrementCounterField"
},
")[]"
],
"description": [
"- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1672,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1672"
}
},
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterOptions",
"text": "SavedObjectsIncrementCounterOptions"
}
],
"description": [
"- {@link SavedObjectsIncrementCounterOptions}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1673,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1673"
}
}
],
"tags": [
"remarks",
"example"
],
"returnComment": [
"The saved object after the specified fields were incremented"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1669,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1669"
}
},
{
"id": "def-server.SavedObjectsRepository.openPointInTimeForType",
"type": "Function",
"label": "openPointInTimeForType",
"signature": [
"(type: string | string[], { keepAlive, preference }?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">"
],
"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"
],
"children": [
{
"type": "CompoundType",
"label": "type",
"isRequired": true,
"signature": [
"string | string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1821,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1821"
}
},
{
"type": "Object",
"label": "{ keepAlive = '5m', preference }",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1822,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1822"
}
}
],
"tags": [
"example",
"property",
"property"
],
"returnComment": [
"- { id: string }"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1820,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1820"
}
},
{
"id": "def-server.SavedObjectsRepository.closePointInTime",
"type": "Function",
"label": "closePointInTime",
"signature": [
"(id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">"
],
"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"
],
"children": [
{
"type": "string",
"label": "id",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1890,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1890"
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined"
],
"description": [
"- {@link SavedObjectsClosePointInTimeOptions}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1891,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1891"
}
}
],
"tags": [
"remarks",
"example"
],
"returnComment": [
"- {@link SavedObjectsClosePointInTimeResponse}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 1889,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1889"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 143,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L143"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsExporter",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsExporter",
"description": [],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsExporter.#savedObjectsClient",
"type": "Object",
"label": "#savedObjectsClient",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L38"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsExporter.#exportTransforms",
"type": "Object",
"label": "#exportTransforms",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L39"
},
"signature": [
"Record<string, ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportTransform",
"text": "SavedObjectsExportTransform"
},
">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsExporter.#exportSizeLimit",
"type": "number",
"label": "#exportSizeLimit",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L40"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsExporter.#log",
"type": "Object",
"label": "#log",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L41"
},
"signature": [
"Logger"
]
},
{
"id": "def-server.SavedObjectsExporter.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }",
"type": "Object",
"label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.savedObjectsClient",
"type": "Object",
"label": "savedObjectsClient",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L49"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.typeRegistry",
"type": "Object",
"label": "typeRegistry",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L50"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectTypeRegistry",
"text": "SavedObjectTypeRegistry"
},
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.exportSizeLimit",
"type": "number",
"label": "exportSizeLimit",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L51"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.logger",
"type": "Object",
"label": "logger",
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L52"
},
"signature": [
"Logger"
]
}
],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L48"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L43"
}
},
{
"id": "def-server.SavedObjectsExporter.exportByTypes",
"type": "Function",
"label": "exportByTypes",
"signature": [
"(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByTypeOptions",
"text": "SavedObjectsExportByTypeOptions"
},
") => Promise<",
"Readable",
">"
],
"description": [
"\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n"
],
"children": [
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByTypeOptions",
"text": "SavedObjectsExportByTypeOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L75"
}
}
],
"tags": [
"throws"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L75"
}
},
{
"id": "def-server.SavedObjectsExporter.exportByObjects",
"type": "Function",
"label": "exportByObjects",
"signature": [
"(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByObjectOptions",
"text": "SavedObjectsExportByObjectOptions"
},
") => Promise<",
"Readable",
">"
],
"description": [
"\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n"
],
"children": [
{
"type": "Object",
"label": "options",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByObjectOptions",
"text": "SavedObjectsExportByObjectOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 93,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L93"
}
}
],
"tags": [
"throws"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 93,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L93"
}
}
],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L37"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsExportError",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsExportError",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
},
" extends Error"
],
"children": [
{
"id": "def-server.SavedObjectsExportError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "string",
"label": "type",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L16"
}
},
{
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L17"
}
},
{
"type": "Object",
"label": "attributes",
"isRequired": false,
"signature": [
"Record<string, any> | undefined"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L18"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L15"
}
},
{
"id": "def-server.SavedObjectsExportError.exportSizeExceeded",
"type": "Function",
"label": "exportSizeExceeded",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
},
".exportSizeExceeded"
],
"description": [],
"children": [
{
"type": "number",
"label": "limit",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L27"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L27"
}
},
{
"id": "def-server.SavedObjectsExportError.objectFetchError",
"type": "Function",
"label": "objectFetchError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
},
".objectFetchError"
],
"description": [],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<unknown>[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L34"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L34"
}
},
{
"id": "def-server.SavedObjectsExportError.objectTransformError",
"type": "Function",
"label": "objectTransformError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
},
".objectTransformError"
],
"description": [
"\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error"
],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<unknown>[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43"
}
},
{
"type": "Object",
"label": "cause",
"isRequired": true,
"signature": [
"Error"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43"
}
},
{
"id": "def-server.SavedObjectsExportError.invalidTransformError",
"type": "Function",
"label": "invalidTransformError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
},
".invalidTransformError"
],
"description": [
"\nError returned when a {@link SavedObjectsExportTransform | export tranform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id."
],
"children": [
{
"type": "Array",
"label": "objectKeys",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L58"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L58"
}
}
],
"source": {
"path": "src/core/server/saved_objects/export/errors.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L14"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImporter",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsImporter",
"description": [],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImporter.#savedObjectsClient",
"type": "Object",
"label": "#savedObjectsClient",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L30"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImporter.#typeRegistry",
"type": "Object",
"label": "#typeRegistry",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L31"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectTypeRegistry",
"text": "SavedObjectTypeRegistry"
},
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImporter.#importSizeLimit",
"type": "number",
"label": "#importSizeLimit",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L32"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImporter.#importHooks",
"type": "Object",
"label": "#importHooks",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L33"
},
"signature": [
"Record<string, ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportHook",
"text": "SavedObjectsImportHook"
},
"<unknown>[]>"
]
},
{
"id": "def-server.SavedObjectsImporter.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }",
"type": "Object",
"label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.savedObjectsClient",
"type": "Object",
"label": "savedObjectsClient",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L40"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.typeRegistry",
"type": "Object",
"label": "typeRegistry",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L41"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectTypeRegistry",
"text": "SavedObjectTypeRegistry"
},
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.importSizeLimit",
"type": "number",
"label": "importSizeLimit",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L42"
}
}
],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L39"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L35"
}
},
{
"id": "def-server.SavedObjectsImporter.import",
"type": "Function",
"label": "import",
"signature": [
"({ readStream, createNewCopies, namespace, overwrite, }: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportOptions",
"text": "SavedObjectsImportOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportResponse",
"text": "SavedObjectsImportResponse"
},
">"
],
"description": [
"\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n"
],
"children": [
{
"type": "Object",
"label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportOptions",
"text": "SavedObjectsImportOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L64"
}
}
],
"tags": [
"throws"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L64"
}
},
{
"id": "def-server.SavedObjectsImporter.resolveImportErrors",
"type": "Function",
"label": "resolveImportErrors",
"signature": [
"({ readStream, createNewCopies, namespace, retries, }: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveImportErrorsOptions",
"text": "SavedObjectsResolveImportErrorsOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportResponse",
"text": "SavedObjectsImportResponse"
},
">"
],
"description": [
"\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n"
],
"children": [
{
"type": "Object",
"label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveImportErrorsOptions",
"text": "SavedObjectsResolveImportErrorsOptions"
}
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L88"
}
}
],
"tags": [
"throws"
],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L88"
}
}
],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L29"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportError",
"type": "Class",
"tags": [
"public"
],
"label": "SavedObjectsImportError",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
},
" extends Error"
],
"children": [
{
"id": "def-server.SavedObjectsImportError.importSizeExceeded",
"type": "Function",
"label": "importSizeExceeded",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
},
".importSizeExceeded"
],
"description": [],
"children": [
{
"type": "number",
"label": "limit",
"isRequired": true,
"signature": [
"number"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L27"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L27"
}
},
{
"id": "def-server.SavedObjectsImportError.nonUniqueImportObjects",
"type": "Function",
"label": "nonUniqueImportObjects",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
},
".nonUniqueImportObjects"
],
"description": [],
"children": [
{
"type": "Array",
"label": "nonUniqueEntries",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L34"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L34"
}
},
{
"id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects",
"type": "Function",
"label": "nonUniqueRetryObjects",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
},
".nonUniqueRetryObjects"
],
"description": [],
"children": [
{
"type": "Array",
"label": "nonUniqueRetryObjects",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L41"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 41,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L41"
}
},
{
"id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations",
"type": "Function",
"label": "nonUniqueRetryDestinations",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
},
".nonUniqueRetryDestinations"
],
"description": [],
"children": [
{
"type": "Array",
"label": "nonUniqueRetryDestinations",
"isRequired": true,
"signature": [
"string[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L48"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 48,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L48"
}
},
{
"id": "def-server.SavedObjectsImportError.referencesFetchError",
"type": "Function",
"label": "referencesFetchError",
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
},
".referencesFetchError"
],
"description": [],
"children": [
{
"type": "Array",
"label": "objects",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<unknown>[]"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L55"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L55"
}
}
],
"source": {
"path": "src/core/server/saved_objects/import/errors.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L14"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-server.SavedObjectsBulkCreateObject",
"type": "Interface",
"label": "SavedObjectsBulkCreateObject",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L66"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L67"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.attributes",
"type": "Uncategorized",
"label": "attributes",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 68,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L68"
},
"signature": [
"T"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.version",
"type": "string",
"label": "version",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L69"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 70,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L70"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.migrationVersion",
"type": "Object",
"label": "migrationVersion",
"description": [
"{@inheritDoc SavedObjectsMigrationVersion}"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 72,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L72"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectsMigrationVersion",
"text": "SavedObjectsMigrationVersion"
},
" | undefined"
]
},
{
"tags": [
"remarks"
],
"id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion",
"type": "string",
"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"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 82,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L82"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.originId",
"type": "string",
"label": "originId",
"description": [
"Optional ID of the original saved object, if this object's `id` was regenerated"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 84,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L84"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces",
"type": "Array",
"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\nNote: this can only be used for multi-namespace object types."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 91,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L91"
},
"signature": [
"string[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 65,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L65"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsBulkGetObject",
"type": "Interface",
"label": "SavedObjectsBulkGetObject",
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBulkGetObject.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 294,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L294"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkGetObject.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 295,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L295"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkGetObject.fields",
"type": "Array",
"label": "fields",
"description": [
"SavedObject fields to include in the response"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 297,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L297"
},
"signature": [
"string[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 293,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L293"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsBulkUpdateObject",
"type": "Interface",
"label": "SavedObjectsBulkUpdateObject",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T> extends Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
", \"version\" | \"references\">"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBulkUpdateObject.id",
"type": "string",
"label": "id",
"description": [
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L101"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkUpdateObject.type",
"type": "string",
"label": "type",
"description": [
" The type of this Saved Object. Each plugin can define it's own custom Saved Object types."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 103,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L103"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkUpdateObject.attributes",
"type": "Object",
"label": "attributes",
"description": [
"{@inheritdoc SavedObjectAttributes}"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 105,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L105"
},
"signature": [
"Partial<T>"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsBulkUpdateObject.namespace",
"type": "string",
"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`."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 112,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L112"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 98,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L98"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsBulkUpdateOptions",
"type": "Interface",
"label": "SavedObjectsBulkUpdateOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBulkUpdateOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 275,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L275"
},
"signature": [
"boolean | \"wait_for\" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 273,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L273"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsBulkResponse",
"type": "Interface",
"label": "SavedObjectsBulkResponse",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBulkResponse.saved_objects",
"type": "Array",
"label": "saved_objects",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 120,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L120"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 119,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L119"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsBulkResponse",
"type": "Interface",
"label": "SavedObjectsBulkResponse",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBulkResponse.saved_objects",
"type": "Array",
"label": "saved_objects",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 305,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L305"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 304,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L304"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsBulkUpdateResponse",
"type": "Interface",
"label": "SavedObjectsBulkUpdateResponse",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects",
"type": "Array",
"label": "saved_objects",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 313,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L313"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 312,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L312"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsCheckConflictsObject",
"type": "Interface",
"label": "SavedObjectsCheckConflictsObject",
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsCheckConflictsObject.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 184,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L184"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsCheckConflictsObject.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 185,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L185"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 183,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L183"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsCheckConflictsResponse",
"type": "Interface",
"label": "SavedObjectsCheckConflictsResponse",
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsCheckConflictsResponse.errors",
"type": "Array",
"label": "errors",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 193,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L193"
},
"signature": [
"{ id: string; type: string; error: ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectError",
"text": "SavedObjectError"
},
"; }[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 192,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L192"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsClientProviderOptions",
"type": "Interface",
"label": "SavedObjectsClientProviderOptions",
"description": [
"\nOptions to control the creation of the Saved Objects Client."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers",
"type": "Array",
"label": "excludedWrappers",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L58"
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes",
"type": "Array",
"label": "includedHiddenTypes",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L59"
},
"signature": [
"string[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 57,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L57"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsClientWrapperOptions",
"type": "Interface",
"label": "SavedObjectsClientWrapperOptions",
"description": [
"\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsClientWrapperOptions.client",
"type": "Object",
"label": "client",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L20"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry",
"type": "Object",
"label": "typeRegistry",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L21"
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectTypeRegistry",
"text": "SavedObjectTypeRegistry"
},
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsClientWrapperOptions.request",
"type": "Object",
"label": "request",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L22"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L19"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsClosePointInTimeResponse",
"type": "Interface",
"label": "SavedObjectsClosePointInTimeResponse",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded",
"type": "boolean",
"label": "succeeded",
"description": [
"\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 385,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L385"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed",
"type": "number",
"label": "num_freed",
"description": [
"\nThe number of search contexts that have been successfully closed."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 389,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L389"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 380,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L380"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsCreateOptions",
"type": "Interface",
"label": "SavedObjectsCreateOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.id",
"type": "string",
"label": "id",
"description": [
"(not recommended) Specify an id for the document"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L27"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.overwrite",
"type": "CompoundType",
"label": "overwrite",
"description": [
"Overwrite existing documents (defaults to false)"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L29"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.version",
"type": "string",
"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."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L34"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.migrationVersion",
"type": "Object",
"label": "migrationVersion",
"description": [
"{@inheritDoc SavedObjectsMigrationVersion}"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L36"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectsMigrationVersion",
"text": "SavedObjectsMigrationVersion"
},
" | undefined"
]
},
{
"tags": [
"remarks"
],
"id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion",
"type": "string",
"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"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L46"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 47,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L47"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L49"
},
"signature": [
"boolean | \"wait_for\" | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.originId",
"type": "string",
"label": "originId",
"description": [
"Optional ID of the original saved object, if this object's `id` was regenerated"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 51,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L51"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCreateOptions.initialNamespaces",
"type": "Array",
"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\nNote: this can only be used for multi-namespace object types."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 58,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L58"
},
"signature": [
"string[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L25"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsExportResultDetails",
"type": "Interface",
"label": "SavedObjectsExportResultDetails",
"description": [
"\nStructure of the export result details entry"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsExportResultDetails.exportedCount",
"type": "number",
"label": "exportedCount",
"description": [
"number of successfully exported objects"
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L59"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsExportResultDetails.missingRefCount",
"type": "number",
"label": "missingRefCount",
"description": [
"number of missing references"
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 61,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L61"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsExportResultDetails.missingReferences",
"type": "Array",
"label": "missingReferences",
"description": [
"missing references details"
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L63"
},
"signature": [
"{ id: string; type: string; }[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 57,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L57"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsFindResult",
"type": "Interface",
"label": "SavedObjectsFindResult",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResult",
"text": "SavedObjectsFindResult"
},
"<T> extends ",
"SavedObject",
"<T>"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsFindResult.score",
"type": "number",
"label": "score",
"description": [
"\nThe Elasticsearch `_score` of this result."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 131,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L131"
}
},
{
"tags": [
"remarks",
"example"
],
"id": "def-server.SavedObjectsFindResult.sort",
"type": "Array",
"label": "sort",
"description": [
"\nThe Elasticsearch `sort` value of this result.\n"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 160,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L160"
},
"signature": [
"unknown[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 127,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L127"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsFindResponse",
"type": "Interface",
"label": "SavedObjectsFindResponse",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T>"
],
"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"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsFindResponse.saved_objects",
"type": "Array",
"label": "saved_objects",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 172,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L172"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResult",
"text": "SavedObjectsFindResult"
},
"<T>[]"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindResponse.total",
"type": "number",
"label": "total",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 173,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L173"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsFindResponse.per_page",
"type": "number",
"label": "per_page",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 174,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L174"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsFindResponse.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 175,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L175"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsFindResponse.pit_id",
"type": "string",
"label": "pit_id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 176,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L176"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 171,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L171"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportConflictError",
"type": "Interface",
"label": "SavedObjectsImportConflictError",
"description": [
"\nRepresents a failure to import due to a conflict."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportConflictError.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L45"
},
"signature": [
"\"conflict\""
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportConflictError.destinationId",
"type": "string",
"label": "destinationId",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L46"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L44"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportAmbiguousConflictError",
"type": "Interface",
"label": "SavedObjectsImportAmbiguousConflictError",
"description": [
"\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportAmbiguousConflictError.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 54,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L54"
},
"signature": [
"\"ambiguous_conflict\""
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations",
"type": "Array",
"label": "destinations",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L55"
},
"signature": [
"{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 53,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L53"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportFailure",
"type": "Interface",
"label": "SavedObjectsImportFailure",
"description": [
"\nRepresents a failure to import."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportFailure.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 90,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L90"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportFailure.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 91,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L91"
}
},
{
"tags": [
"deprecated"
],
"id": "def-server.SavedObjectsImportFailure.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 95,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L95"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportFailure.meta",
"type": "Object",
"label": "meta",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 96,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L96"
},
"signature": [
"{ title?: string | undefined; icon?: string | undefined; }"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportFailure.overwrite",
"type": "CompoundType",
"label": "overwrite",
"description": [
"\nIf `overwrite` is specified, an attempt was made to overwrite an existing object."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 100,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L100"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportFailure.error",
"type": "CompoundType",
"label": "error",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L101"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportConflictError",
"text": "SavedObjectsImportConflictError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportAmbiguousConflictError",
"text": "SavedObjectsImportAmbiguousConflictError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportUnsupportedTypeError",
"text": "SavedObjectsImportUnsupportedTypeError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportMissingReferencesError",
"text": "SavedObjectsImportMissingReferencesError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportUnknownError",
"text": "SavedObjectsImportUnknownError"
}
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 89,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L89"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportMissingReferencesError",
"type": "Interface",
"label": "SavedObjectsImportMissingReferencesError",
"description": [
"\nRepresents a failure to import due to missing references."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportMissingReferencesError.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L81"
},
"signature": [
"\"missing_references\""
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportMissingReferencesError.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 82,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L82"
},
"signature": [
"{ type: string; id: string; }[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L80"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportOptions",
"type": "Interface",
"label": "SavedObjectsImportOptions",
"description": [
"\nOptions to control the import operation."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportOptions.readStream",
"type": "Object",
"label": "readStream",
"description": [
"The stream of {@link SavedObject | saved objects} to import"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L155"
},
"signature": [
"Readable"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportOptions.overwrite",
"type": "boolean",
"label": "overwrite",
"description": [
"If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 157,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L157"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportOptions.namespace",
"type": "string",
"label": "namespace",
"description": [
"if specified, will import in given namespace, else will import as global object"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 159,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L159"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportOptions.createNewCopies",
"type": "boolean",
"label": "createNewCopies",
"description": [
"If true, will create new copies of import objects, each with a random `id` and undefined `originId`."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 161,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L161"
}
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 153,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L153"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportResponse",
"type": "Interface",
"label": "SavedObjectsImportResponse",
"description": [
"\nThe response describing the result of an import."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportResponse.success",
"type": "boolean",
"label": "success",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 142,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L142"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportResponse.successCount",
"type": "number",
"label": "successCount",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 143,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L143"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportResponse.successResults",
"type": "Array",
"label": "successResults",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 144,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L144"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportSuccess",
"text": "SavedObjectsImportSuccess"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportResponse.warnings",
"type": "Array",
"label": "warnings",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 145,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L145"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportWarning",
"text": "SavedObjectsImportWarning"
},
"[]"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportResponse.errors",
"type": "Array",
"label": "errors",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 146,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L146"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportFailure",
"text": "SavedObjectsImportFailure"
},
"[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 141,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L141"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportRetry",
"type": "Interface",
"label": "SavedObjectsImportRetry",
"description": [
"\nDescribes a retry operation for importing a saved object."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportRetry.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L17"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportRetry.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L18"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportRetry.overwrite",
"type": "boolean",
"label": "overwrite",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L19"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportRetry.destinationId",
"type": "string",
"label": "destinationId",
"description": [
"\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L23"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportRetry.replaceReferences",
"type": "Array",
"label": "replaceReferences",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L24"
},
"signature": [
"{ type: string; from: string; to: string; }[]"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportRetry.createNewCopy",
"type": "CompoundType",
"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."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L33"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences",
"type": "CompoundType",
"label": "ignoreMissingReferences",
"description": [
"\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L37"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L16"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportSuccess",
"type": "Interface",
"label": "SavedObjectsImportSuccess",
"description": [
"\nRepresents a successful import."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportSuccess.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 114,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L114"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportSuccess.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 115,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L115"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportSuccess.destinationId",
"type": "string",
"label": "destinationId",
"description": [
"\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 119,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L119"
},
"signature": [
"string | undefined"
]
},
{
"tags": [
"deprecated"
],
"id": "def-server.SavedObjectsImportSuccess.createNewCopy",
"type": "CompoundType",
"label": "createNewCopy",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 126,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L126"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportSuccess.meta",
"type": "Object",
"label": "meta",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 127,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L127"
},
"signature": [
"{ title?: string | undefined; icon?: string | undefined; }"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportSuccess.overwrite",
"type": "CompoundType",
"label": "overwrite",
"description": [
"\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 134,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L134"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 113,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L113"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportUnknownError",
"type": "Interface",
"label": "SavedObjectsImportUnknownError",
"description": [
"\nRepresents a failure to import due to an unknown reason."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportUnknownError.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L71"
},
"signature": [
"\"unknown\""
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportUnknownError.message",
"type": "string",
"label": "message",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 72,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L72"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportUnknownError.statusCode",
"type": "number",
"label": "statusCode",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L73"
}
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 70,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L70"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportUnsupportedTypeError",
"type": "Interface",
"label": "SavedObjectsImportUnsupportedTypeError",
"description": [
"\nRepresents a failure to import due to having an unsupported saved object type."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportUnsupportedTypeError.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L63"
},
"signature": [
"\"unsupported_type\""
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 62,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L62"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectMigrationContext",
"type": "Interface",
"label": "SavedObjectMigrationContext",
"description": [
"\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectMigrationContext.log",
"type": "Object",
"label": "log",
"description": [
"\nlogger instance to be used by the migration handler"
],
"source": {
"path": "src/core/server/saved_objects/migrations/types.ts",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L59"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsMigrationLogger",
"text": "SavedObjectsMigrationLogger"
}
]
},
{
"tags": [],
"id": "def-server.SavedObjectMigrationContext.migrationVersion",
"type": "string",
"label": "migrationVersion",
"description": [
"\nThe migration version that this migration function is defined for"
],
"source": {
"path": "src/core/server/saved_objects/migrations/types.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L63"
}
},
{
"tags": [],
"id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion",
"type": "string",
"label": "convertToMultiNamespaceTypeVersion",
"description": [
"\nThe version in which this object type is being converted to a multi-namespace type"
],
"source": {
"path": "src/core/server/saved_objects/migrations/types.ts",
"lineNumber": 67,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L67"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/migrations/types.ts",
"lineNumber": 55,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L55"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsMigrationLogger",
"type": "Interface",
"label": "SavedObjectsMigrationLogger",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsMigrationLogger.debug",
"type": "Function",
"label": "debug",
"description": [],
"source": {
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L20"
},
"signature": [
"(msg: string) => void"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsMigrationLogger.info",
"type": "Function",
"label": "info",
"description": [],
"source": {
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L21"
},
"signature": [
"(msg: string) => void"
]
},
{
"tags": [
"deprecated"
],
"id": "def-server.SavedObjectsMigrationLogger.warning",
"type": "Function",
"label": "warning",
"description": [],
"source": {
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L25"
},
"signature": [
"(msg: string) => void"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsMigrationLogger.warn",
"type": "Function",
"label": "warn",
"description": [],
"source": {
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L26"
},
"signature": [
"(msg: string) => void"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsMigrationLogger.error",
"type": "Function",
"label": "error",
"description": [],
"source": {
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L27"
},
"signature": [
"(msg: string, meta: ",
"LogMeta",
") => void"
]
}
],
"source": {
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L19"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsOpenPointInTimeOptions",
"type": "Interface",
"label": "SavedObjectsOpenPointInTimeOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive",
"type": "string",
"label": "keepAlive",
"description": [
"\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 355,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L355"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsOpenPointInTimeOptions.preference",
"type": "string",
"label": "preference",
"description": [
"\nAn optional ES preference value to be used for the query."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 359,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L359"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 351,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L351"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsOpenPointInTimeResponse",
"type": "Interface",
"label": "SavedObjectsOpenPointInTimeResponse",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsOpenPointInTimeResponse.id",
"type": "string",
"label": "id",
"description": [
"\nPIT ID returned from ES."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 369,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L369"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 365,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L365"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsRawDoc",
"type": "Interface",
"label": "SavedObjectsRawDoc",
"description": [
"\nA raw document as represented directly in the saved object index.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsRawDoc._id",
"type": "string",
"label": "_id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L17"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsRawDoc._source",
"type": "Object",
"label": "_source",
"description": [],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L18"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDocSource",
"text": "SavedObjectsRawDocSource"
}
]
},
{
"tags": [],
"id": "def-server.SavedObjectsRawDoc._seq_no",
"type": "number",
"label": "_seq_no",
"description": [],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L19"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsRawDoc._primary_term",
"type": "number",
"label": "_primary_term",
"description": [],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L20"
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L16"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsRawDocParseOptions",
"type": "Interface",
"label": "SavedObjectsRawDocParseOptions",
"description": [
"\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment",
"type": "CompoundType",
"label": "namespaceTreatment",
"description": [
"\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`."
],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 86,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L86"
},
"signature": [
"\"strict\" | \"lax\" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 78,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L78"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsRepositoryFactory",
"type": "Interface",
"label": "SavedObjectsRepositoryFactory",
"description": [
"\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository",
"type": "Function",
"label": "createScopedRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n"
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 234,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L234"
},
"signature": [
"(req: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>, includedHiddenTypes?: string[] | undefined) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository",
"type": "Function",
"label": "createInternalRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n"
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 244,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L244"
},
"signature": [
"(includedHiddenTypes?: string[] | undefined) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"
]
}
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 226,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L226"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsResolveImportErrorsOptions",
"type": "Interface",
"label": "SavedObjectsResolveImportErrorsOptions",
"description": [
"\nOptions to control the \"resolve import\" operation."
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream",
"type": "Object",
"label": "readStream",
"description": [
"The stream of {@link SavedObject | saved objects} to resolve errors from"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 170,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L170"
},
"signature": [
"Readable"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsResolveImportErrorsOptions.retries",
"type": "Array",
"label": "retries",
"description": [
"saved object import references to retry"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 172,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L172"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportRetry",
"text": "SavedObjectsImportRetry"
},
"[]"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace",
"type": "string",
"label": "namespace",
"description": [
"if specified, will import in given namespace"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 174,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L174"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies",
"type": "boolean",
"label": "createNewCopies",
"description": [
"If true, will create new copies of import objects, each with a random `id` and undefined `originId`."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 176,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L176"
}
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 168,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L168"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsResolveResponse",
"type": "Interface",
"label": "SavedObjectsResolveResponse",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsResolveResponse.saved_object",
"type": "Object",
"label": "saved_object",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 331,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L331"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsResolveResponse.outcome",
"type": "CompoundType",
"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."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 341,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L341"
},
"signature": [
"\"conflict\" | \"exactMatch\" | \"aliasMatch\""
]
},
{
"tags": [],
"id": "def-server.SavedObjectsResolveResponse.aliasTargetId",
"type": "string",
"label": "aliasTargetId",
"description": [
"\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 345,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L345"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 330,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L330"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsUpdateOptions",
"type": "Interface",
"label": "SavedObjectsUpdateOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsUpdateOptions.version",
"type": "string",
"label": "version",
"description": [
"An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 206,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L206"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsUpdateOptions.references",
"type": "Array",
"label": "references",
"description": [
"{@inheritdoc SavedObjectReference}"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 208,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L208"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsUpdateOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 210,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L210"
},
"signature": [
"boolean | \"wait_for\" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 204,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L204"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsUpdateResponse",
"type": "Interface",
"label": "SavedObjectsUpdateResponse",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T> extends Pick<",
"SavedObject",
"<T>, \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">"
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsUpdateResponse.attributes",
"type": "Object",
"label": "attributes",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 322,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L322"
},
"signature": [
"Partial<T>"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsUpdateResponse.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 323,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L323"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 320,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L320"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsAddToNamespacesOptions",
"type": "Interface",
"label": "SavedObjectsAddToNamespacesOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsAddToNamespacesOptions",
"text": "SavedObjectsAddToNamespacesOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsAddToNamespacesOptions.version",
"type": "string",
"label": "version",
"description": [
"An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 219,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L219"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsAddToNamespacesOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 221,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L221"
},
"signature": [
"boolean | \"wait_for\" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 217,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L217"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsAddToNamespacesResponse",
"type": "Interface",
"label": "SavedObjectsAddToNamespacesResponse",
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsAddToNamespacesResponse.namespaces",
"type": "Array",
"label": "namespaces",
"description": [
"The namespaces the object exists in after this operation is complete."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 230,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L230"
},
"signature": [
"string[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 228,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L228"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsDeleteFromNamespacesOptions",
"type": "Interface",
"label": "SavedObjectsDeleteFromNamespacesOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteFromNamespacesOptions",
"text": "SavedObjectsDeleteFromNamespacesOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsDeleteFromNamespacesOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 239,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L239"
},
"signature": [
"boolean | \"wait_for\" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 237,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L237"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsDeleteFromNamespacesResponse",
"type": "Interface",
"label": "SavedObjectsDeleteFromNamespacesResponse",
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsDeleteFromNamespacesResponse.namespaces",
"type": "Array",
"label": "namespaces",
"description": [
"The namespaces the object exists in after this operation is complete. An empty array indicates the object was deleted."
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 248,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L248"
},
"signature": [
"string[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 246,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L246"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsRemoveReferencesToOptions",
"type": "Interface",
"label": "SavedObjectsRemoveReferencesToOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation. Defaults to `true`"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 257,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L257"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 255,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L255"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsRemoveReferencesToResponse",
"type": "Interface",
"label": "SavedObjectsRemoveReferencesToResponse",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsRemoveReferencesToResponse.updated",
"type": "number",
"label": "updated",
"description": [
"The number of objects that have been updated by this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 266,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L266"
}
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 264,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L264"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsServiceStart",
"type": "Interface",
"label": "SavedObjectsServiceStart",
"description": [
"\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The\nSavedObjectsServiceStart API provides a scoped Saved Objects client for\ninteracting with Saved Objects.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsServiceStart.getScopedClient",
"type": "Function",
"label": "getScopedClient",
"description": [
"\nCreates a {@link SavedObjectsClientContract | Saved Objects client} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch. If other plugins have registered Saved Objects client\nwrappers, these will be applied to extend the functionality of the client.\n\nA client that is already scoped to the incoming request is also exposed\nfrom the route handler context see {@link RequestHandlerContext}."
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 172,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L172"
},
"signature": [
"(req: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientProviderOptions",
"text": "SavedObjectsClientProviderOptions"
},
" | undefined) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
]
},
{
"tags": [
"remarks"
],
"id": "def-server.SavedObjectsServiceStart.createScopedRepository",
"type": "Function",
"label": "createScopedRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n"
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 188,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L188"
},
"signature": [
"(req: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>, includedHiddenTypes?: string[] | undefined) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsServiceStart.createInternalRepository",
"type": "Function",
"label": "createInternalRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n"
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 198,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L198"
},
"signature": [
"(includedHiddenTypes?: string[] | undefined) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsServiceStart.createSerializer",
"type": "Function",
"label": "createSerializer",
"description": [
"\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types."
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 202,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L202"
},
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsSerializer",
"text": "SavedObjectsSerializer"
}
]
},
{
"tags": [],
"id": "def-server.SavedObjectsServiceStart.createExporter",
"type": "Function",
"label": "createExporter",
"description": [
"\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client."
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 206,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L206"
},
"signature": [
"(client: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExporter",
"text": "SavedObjectsExporter"
},
", \"exportByTypes\" | \"exportByObjects\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsServiceStart.createImporter",
"type": "Function",
"label": "createImporter",
"description": [
"\nCreates an {@link ISavedObjectsImporter | importer} bound to given client."
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 210,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L210"
},
"signature": [
"(client: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImporter",
"text": "SavedObjectsImporter"
},
", \"import\" | \"resolveImportErrors\">"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsServiceStart.getTypeRegistry",
"type": "Function",
"label": "getTypeRegistry",
"description": [
"\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}"
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 215,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L215"
},
"signature": [
"() => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectTypeRegistry",
"text": "SavedObjectTypeRegistry"
},
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"
]
}
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 162,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L162"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsServiceSetup",
"type": "Interface",
"label": "SavedObjectsServiceSetup",
"description": [
"\nSaved Objects is Kibana's data persistence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods\nfor registering Saved Object types, creating and registering Saved Object client wrappers and factories.\n"
],
"tags": [
"remarks",
"example",
"example",
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider",
"type": "Function",
"label": "setClientFactoryProvider",
"description": [
"\nSet the default {@link SavedObjectsClientFactoryProvider | factory provider} for creating Saved Objects clients.\nOnly one provider can be set, subsequent calls to this method will fail."
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 90,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L90"
},
"signature": [
"(clientFactoryProvider: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientFactoryProvider",
"text": "SavedObjectsClientFactoryProvider"
},
") => void"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsServiceSetup.addClientWrapper",
"type": "Function",
"label": "addClientWrapper",
"description": [
"\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority."
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 95,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L95"
},
"signature": [
"(priority: number, id: string, factory: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientWrapperFactory",
"text": "SavedObjectsClientWrapperFactory"
},
") => void"
]
},
{
"tags": [
"example"
],
"id": "def-server.SavedObjectsServiceSetup.registerType",
"type": "Function",
"label": "registerType",
"description": [
"\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n"
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 144,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L144"
},
"signature": [
"(type: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
") => void"
]
}
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L85"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectStatusMeta",
"type": "Interface",
"label": "SavedObjectStatusMeta",
"description": [
"\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectStatusMeta.migratedIndices",
"type": "Object",
"label": "migratedIndices",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 50,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L50"
},
"signature": [
"{ [status: string]: number; skipped: number; migrated: number; }"
]
}
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L49"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsDeleteOptions",
"type": "Interface",
"label": "SavedObjectsDeleteOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsDeleteOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 284,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L284"
},
"signature": [
"boolean | \"wait_for\" | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsDeleteOptions.force",
"type": "CompoundType",
"label": "force",
"description": [
"Force deletion of an object that exists in multiple namespaces"
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 286,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L286"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 282,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L282"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsDeleteByNamespaceOptions",
"type": "Interface",
"label": "SavedObjectsDeleteByNamespaceOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteByNamespaceOptions",
"text": "SavedObjectsDeleteByNamespaceOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"The Elasticsearch supports only boolean flag for this operation"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 118,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L118"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 116,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L116"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsIncrementCounterOptions",
"type": "Interface",
"label": "SavedObjectsIncrementCounterOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterOptions",
"text": "SavedObjectsIncrementCounterOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsIncrementCounterOptions.initialize",
"type": "CompoundType",
"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."
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 102,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L102"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion",
"type": "Object",
"label": "migrationVersion",
"description": [
"{@link SavedObjectsMigrationVersion}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 104,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L104"
},
"signature": [
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObjectsMigrationVersion",
"text": "SavedObjectsMigrationVersion"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsIncrementCounterOptions.refresh",
"type": "CompoundType",
"label": "refresh",
"description": [
"\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 109,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L109"
},
"signature": [
"boolean | \"wait_for\" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 97,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L97"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsIncrementCounterField",
"type": "Interface",
"label": "SavedObjectsIncrementCounterField",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsIncrementCounterField.fieldName",
"type": "string",
"label": "fieldName",
"description": [
"The field name to increment the counter by."
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 135,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L135"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsIncrementCounterField.incrementBy",
"type": "number",
"label": "incrementBy",
"description": [
"The number to increment the field by (defaults to 1)."
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 137,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L137"
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 133,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L133"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsComplexFieldMapping",
"type": "Interface",
"label": "SavedObjectsComplexFieldMapping",
"description": [
"\nSee {@link SavedObjectsFieldMapping} for documentation.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsComplexFieldMapping.dynamic",
"type": "CompoundType",
"label": "dynamic",
"description": [
"\nThe dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings.\n\nNote: To limit the number of mapping fields Saved Object types should\n*never* use `dynamic: true`."
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 150,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L150"
},
"signature": [
"false | \"strict\" | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsComplexFieldMapping.enabled",
"type": "CompoundType",
"label": "enabled",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 151,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L151"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsComplexFieldMapping.doc_values",
"type": "CompoundType",
"label": "doc_values",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 152,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L152"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsComplexFieldMapping.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 153,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L153"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsComplexFieldMapping.properties",
"type": "Object",
"label": "properties",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 154,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L154"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsMappingProperties",
"text": "SavedObjectsMappingProperties"
}
]
}
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 141,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L141"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsCoreFieldMapping",
"type": "Interface",
"label": "SavedObjectsCoreFieldMapping",
"description": [
"\nSee {@link SavedObjectsFieldMapping} for documentation.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsCoreFieldMapping.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 124,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L124"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsCoreFieldMapping.null_value",
"type": "CompoundType",
"label": "null_value",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 125,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L125"
},
"signature": [
"string | number | boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCoreFieldMapping.index",
"type": "CompoundType",
"label": "index",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 126,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L126"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCoreFieldMapping.doc_values",
"type": "CompoundType",
"label": "doc_values",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 127,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L127"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsCoreFieldMapping.fields",
"type": "Object",
"label": "fields",
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 128,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L128"
},
"signature": [
"{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 123,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L123"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsTypeMappingDefinition",
"type": "Interface",
"label": "SavedObjectsTypeMappingDefinition",
"description": [
"\nDescribe a saved object type mapping.\n"
],
"tags": [
"example",
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsTypeMappingDefinition.dynamic",
"type": "CompoundType",
"label": "dynamic",
"description": [
"The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings."
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L40"
},
"signature": [
"false | \"strict\" | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsTypeMappingDefinition.properties",
"type": "Object",
"label": "properties",
"description": [
"The underlying properties of the type mapping"
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 42,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L42"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsMappingProperties",
"text": "SavedObjectsMappingProperties"
}
]
}
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L36"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsMappingProperties",
"type": "Interface",
"label": "SavedObjectsMappingProperties",
"description": [
"\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n"
],
"tags": [
"public"
],
"children": [
{
"id": "def-server.SavedObjectsMappingProperties.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L88"
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 87,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L87"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsType",
"type": "Interface",
"label": "SavedObjectsType",
"description": [],
"tags": [
"remarks",
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsType.name",
"type": "string",
"label": "name",
"description": [
"\nThe name of the type, which is also used as the internal id."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 237,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L237"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsType.hidden",
"type": "boolean",
"label": "hidden",
"description": [
"\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 244,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L244"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsType.namespaceType",
"type": "CompoundType",
"label": "namespaceType",
"description": [
"\nThe {@link SavedObjectsNamespaceType | namespace type} for the type."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 248,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L248"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsNamespaceType",
"text": "SavedObjectsNamespaceType"
}
]
},
{
"tags": [],
"id": "def-server.SavedObjectsType.indexPattern",
"type": "string",
"label": "indexPattern",
"description": [
"\nIf defined, the type instances will be stored in the given index instead of the default one."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 252,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L252"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsType.convertToAliasScript",
"type": "string",
"label": "convertToAliasScript",
"description": [
"\nIf defined, will be used to convert the type to an alias."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 256,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L256"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsType.mappings",
"type": "Object",
"label": "mappings",
"description": [
"\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 260,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L260"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsTypeMappingDefinition",
"text": "SavedObjectsTypeMappingDefinition"
}
]
},
{
"tags": [],
"id": "def-server.SavedObjectsType.migrations",
"type": "CompoundType",
"label": "migrations",
"description": [
"\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 264,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L264"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectMigrationMap",
"text": "SavedObjectMigrationMap"
},
" | (() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectMigrationMap",
"text": "SavedObjectMigrationMap"
},
") | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion",
"type": "string",
"label": "convertToMultiNamespaceTypeVersion",
"description": [
"\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 313,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L313"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsType.management",
"type": "Object",
"label": "management",
"description": [
"\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 317,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L317"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsTypeManagementDefinition",
"text": "SavedObjectsTypeManagementDefinition"
},
" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 233,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L233"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsTypeManagementDefinition",
"type": "Interface",
"label": "SavedObjectsTypeManagementDefinition",
"description": [
"\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable",
"type": "CompoundType",
"label": "importableAndExportable",
"description": [
"\nIs the type importable or exportable. Defaults to `false`."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 329,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L329"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField",
"type": "string",
"label": "defaultSearchField",
"description": [
"\nThe default search field to use for this type. Defaults to `id`."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 333,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L333"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsTypeManagementDefinition.icon",
"type": "string",
"label": "icon",
"description": [
"\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 338,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L338"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsTypeManagementDefinition.getTitle",
"type": "Function",
"label": "getTitle",
"description": [
"\nFunction returning the title to display in the management table.\nIf not defined, will use the object's type and id to generate a label."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 343,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L343"
},
"signature": [
"((savedObject: ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<any>) => string) | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl",
"type": "Function",
"label": "getEditUrl",
"description": [
"\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 348,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L348"
},
"signature": [
"((savedObject: ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<any>) => string) | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl",
"type": "Function",
"label": "getInAppUrl",
"description": [
"\nFunction returning the url to use to redirect to this object from the management section.\nIf not defined, redirecting to the object will not be allowed.\n"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 357,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L357"
},
"signature": [
"((savedObject: ",
{
"pluginId": "core",
"scope": "common",
"docId": "kibCorePluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<any>) => { path: string; uiCapabilitiesPath: string; }) | undefined"
]
},
{
"tags": [
"remarks"
],
"id": "def-server.SavedObjectsTypeManagementDefinition.onExport",
"type": "Function",
"label": "onExport",
"description": [
"\nAn optional export transform function that can be used transform the objects of the registered type during\nthe export process.\n\nIt can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.\n\nSee {@link SavedObjectsExportTransform | the transform type documentation} for more info and examples.\n"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 368,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L368"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportTransform",
"text": "SavedObjectsExportTransform"
},
" | undefined"
]
},
{
"tags": [
"example",
"remarks",
"remarks"
],
"id": "def-server.SavedObjectsTypeManagementDefinition.onImport",
"type": "Function",
"label": "onImport",
"description": [
"\nAn optional {@link SavedObjectsImportHook | import hook} to use when importing given type.\n\nImport hooks are executed during the savedObjects import process and allow to interact\nwith the imported objects. See the {@link SavedObjectsImportHook | hook documentation}\nfor more info.\n"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 411,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L411"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportHook",
"text": "SavedObjectsImportHook"
},
"<unknown> | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 325,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L325"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectMigrationMap",
"type": "Interface",
"label": "SavedObjectMigrationMap",
"description": [
"\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n"
],
"tags": [
"example",
"public"
],
"children": [
{
"id": "def-server.SavedObjectMigrationMap.Unnamed",
"type": "Any",
"label": "Unnamed",
"tags": [],
"description": [],
"source": {
"path": "src/core/server/saved_objects/migrations/types.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L88"
},
"signature": [
"any"
]
}
],
"source": {
"path": "src/core/server/saved_objects/migrations/types.ts",
"lineNumber": 87,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L87"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectExportBaseOptions",
"type": "Interface",
"label": "SavedObjectExportBaseOptions",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectExportBaseOptions.request",
"type": "Object",
"label": "request",
"description": [
"The http request initiating the export."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L15"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
]
},
{
"tags": [],
"id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep",
"type": "CompoundType",
"label": "includeReferencesDeep",
"description": [
"flag to also include all related saved objects in the export stream."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L17"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails",
"type": "CompoundType",
"label": "excludeExportDetails",
"description": [
"flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L19"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectExportBaseOptions.namespace",
"type": "string",
"label": "namespace",
"description": [
"optional namespace to override the namespace used by the savedObjectsClient."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L21"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L13"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsExportByObjectOptions",
"type": "Interface",
"label": "SavedObjectsExportByObjectOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByObjectOptions",
"text": "SavedObjectsExportByObjectOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectExportBaseOptions",
"text": "SavedObjectExportBaseOptions"
}
],
"description": [
"\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsExportByObjectOptions.objects",
"type": "Array",
"label": "objects",
"description": [
"optional array of objects to export."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L45"
},
"signature": [
"{ id: string; type: string; }[]"
]
}
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L43"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsExportByTypeOptions",
"type": "Interface",
"label": "SavedObjectsExportByTypeOptions",
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByTypeOptions",
"text": "SavedObjectsExportByTypeOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectExportBaseOptions",
"text": "SavedObjectExportBaseOptions"
}
],
"description": [
"\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsExportByTypeOptions.types",
"type": "Array",
"label": "types",
"description": [
"array of saved object types."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L31"
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsExportByTypeOptions.hasReference",
"type": "Array",
"label": "hasReference",
"description": [
"optional array of references to search object for."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L33"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsExportByTypeOptions.search",
"type": "string",
"label": "search",
"description": [
"optional query string to filter exported objects."
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L35"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L29"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsExportTransformContext",
"type": "Interface",
"label": "SavedObjectsExportTransformContext",
"description": [
"\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsExportTransformContext.request",
"type": "Object",
"label": "request",
"description": [
"\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}"
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L81"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
]
}
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 76,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L76"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportHookResult",
"type": "Interface",
"label": "SavedObjectsImportHookResult",
"description": [
"\nResult from a {@link SavedObjectsImportHook | import hook}\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportHookResult.warnings",
"type": "Array",
"label": "warnings",
"description": [
"\nAn optional list of warnings to display in the UI when the import succeeds."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 231,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L231"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportWarning",
"text": "SavedObjectsImportWarning"
},
"[] | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 227,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L227"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportSimpleWarning",
"type": "Interface",
"label": "SavedObjectsImportSimpleWarning",
"description": [
"\nA simple informative warning that will be displayed to the user.\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportSimpleWarning.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 187,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L187"
},
"signature": [
"\"simple\""
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportSimpleWarning.message",
"type": "string",
"label": "message",
"description": [
"The translated message to display to the user"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 189,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L189"
}
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 186,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L186"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportActionRequiredWarning",
"type": "Interface",
"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"
],
"tags": [
"remark",
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsImportActionRequiredWarning.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 201,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L201"
},
"signature": [
"\"action_required\""
]
},
{
"tags": [],
"id": "def-server.SavedObjectsImportActionRequiredWarning.message",
"type": "string",
"label": "message",
"description": [
"The translated message to display to the user."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 203,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L203"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath",
"type": "string",
"label": "actionPath",
"description": [
"The path (without the basePath) that the user should be redirect to to address this warning."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 205,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L205"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel",
"type": "string",
"label": "buttonLabel",
"description": [
"An optional label to use for the link button. If unspecified, a default label will be used."
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 207,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L207"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 200,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L200"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsBaseOptions",
"type": "Interface",
"label": "SavedObjectsBaseOptions",
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsBaseOptions.namespace",
"type": "string",
"label": "namespace",
"description": [
"Specify the namespace for this operation"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 141,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L141"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 139,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L139"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsFindOptions",
"type": "Interface",
"label": "SavedObjectsFindOptions",
"description": [
"\n"
],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.type",
"type": "CompoundType",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 78,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L78"
},
"signature": [
"string | string[]"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.page",
"type": "number",
"label": "page",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 79,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L79"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.perPage",
"type": "number",
"label": "perPage",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 80,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L80"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.sortField",
"type": "string",
"label": "sortField",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 81,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L81"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.sortOrder",
"type": "string",
"label": "sortOrder",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 82,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L82"
},
"signature": [
"string | undefined"
]
},
{
"tags": [
"example"
],
"id": "def-server.SavedObjectsFindOptions.fields",
"type": "Array",
"label": "fields",
"description": [
"\nAn array of fields to include in the results"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L88"
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.search",
"type": "string",
"label": "search",
"description": [
"Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 90,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L90"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.searchFields",
"type": "Array",
"label": "searchFields",
"description": [
"The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 92,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L92"
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.searchAfter",
"type": "Array",
"label": "searchAfter",
"description": [
"\nUse the sort values from the previous page to retrieve the next page of results."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 96,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L96"
},
"signature": [
"unknown[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.rootSearchFields",
"type": "Array",
"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."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L101"
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.hasReference",
"type": "CompoundType",
"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."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 107,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L107"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.hasReferenceOperator",
"type": "CompoundType",
"label": "hasReferenceOperator",
"description": [
"\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 111,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L111"
},
"signature": [
"\"AND\" | \"OR\" | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.defaultSearchOperator",
"type": "CompoundType",
"label": "defaultSearchOperator",
"description": [
"\nThe search operator to use with the provided filter. Defaults to `OR`"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 116,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L116"
},
"signature": [
"\"AND\" | \"OR\" | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.filter",
"type": "Any",
"label": "filter",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 117,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L117"
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.namespaces",
"type": "Array",
"label": "namespaces",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 118,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L118"
},
"signature": [
"string[] | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap",
"type": "Object",
"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."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 126,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L126"
},
"signature": [
"Map<string, string[] | undefined> | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.preference",
"type": "string",
"label": "preference",
"description": [
"An optional ES preference value to be used for the query"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 128,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L128"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptions.pit",
"type": "Object",
"label": "pit",
"description": [
"\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}."
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 132,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L132"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsPitParams",
"text": "SavedObjectsPitParams"
},
" | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L77"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsFindOptionsReference",
"type": "Interface",
"label": "SavedObjectsFindOptionsReference",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsFindOptionsReference.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 61,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L61"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsFindOptionsReference.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 62,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L62"
}
}
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L60"
},
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsPitParams",
"type": "Interface",
"label": "SavedObjectsPitParams",
"description": [],
"tags": [
"public"
],
"children": [
{
"tags": [],
"id": "def-server.SavedObjectsPitParams.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 69,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L69"
}
},
{
"tags": [],
"id": "def-server.SavedObjectsPitParams.keepAlive",
"type": "string",
"label": "keepAlive",
"description": [],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 70,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L70"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 68,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L68"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-server.SavedObjectsClientWrapperFactory",
"type": "Type",
"label": "SavedObjectsClientWrapperFactory",
"tags": [
"public"
],
"description": [
"\nDescribes the factory used to create instances of Saved Objects Client Wrappers."
],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L29"
},
"signature": [
"(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientWrapperOptions",
"text": "SavedObjectsClientWrapperOptions"
},
") => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsClientFactory",
"type": "Type",
"label": "SavedObjectsClientFactory",
"tags": [
"public"
],
"description": [
"\nDescribes the factory used to create instances of the Saved Objects Client."
],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L37"
},
"signature": [
"(__0: { request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>; includedHiddenTypes?: string[] | undefined; }) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsClientFactoryProvider",
"type": "Type",
"label": "SavedObjectsClientFactoryProvider",
"tags": [
"public"
],
"description": [
"\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}."
],
"source": {
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"lineNumber": 49,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L49"
},
"signature": [
"(repositoryFactory: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepositoryFactory",
"text": "SavedObjectsRepositoryFactory"
},
") => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientFactory",
"text": "SavedObjectsClientFactory"
}
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsClosePointInTimeOptions",
"type": "Type",
"label": "SavedObjectsClosePointInTimeOptions",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"lineNumber": 375,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L375"
},
"signature": [
"SavedObjectsBaseOptions"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectSanitizedDoc",
"type": "Type",
"label": "SavedObjectSanitizedDoc",
"tags": [
"public"
],
"description": [
"\nDescribes Saved Object documents that have passed through the migration\nframework and are guaranteed to have a `references` root property.\n"
],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L71"
},
"signature": [
"SavedObjectDoc<T> & Referencable"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectUnsanitizedDoc",
"type": "Type",
"label": "SavedObjectUnsanitizedDoc",
"tags": [
"public"
],
"description": [
"\nDescribes Saved Object documents from Kibana < 7.0.0 which don't have a\n`references` root property defined. This type should only be used in\nmigrations.\n"
],
"source": {
"path": "src/core/server/saved_objects/serialization/types.ts",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L63"
},
"signature": [
"SavedObjectDoc<T> & Partial<Referencable>"
],
"initialIsOpen": false
},
{
"id": "def-server.ISavedObjectsRepository",
"type": "Type",
"label": "ISavedObjectsRepository",
"tags": [
"public"
],
"description": [
"\nSee {@link SavedObjectsRepository}\n"
],
"source": {
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"lineNumber": 128,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L128"
},
"signature": [
"{ get: <T = unknown>(type: string, id: string, options?: SavedObjectsBaseOptions) => Promise<SavedObject<T>>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions) => Promise<{}>; create: <T = unknown>(type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise<SavedObject<T>>; find: <T = unknown>(options: SavedObjectsFindOptions) => Promise<SavedObjectsFindResponse<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: SavedObjectsUpdateOptions) => Promise<SavedObjectsUpdateResponse<T>>; bulkCreate: <T = unknown>(objects: SavedObjectsBulkCreateObject<T>[], options?: SavedObjectsCreateOptions) => Promise<SavedObjectsBulkResponse<T>>; bulkGet: <T = unknown>(objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions) => Promise<SavedObjectsBulkResponse<T>>; bulkUpdate: <T = unknown>(objects: SavedObjectsBulkUpdateObject<T>[], options?: SavedObjectsBulkUpdateOptions) => Promise<SavedObjectsBulkUpdateResponse<T>>; checkConflicts: (objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions) => Promise<SavedObjectsCheckConflictsResponse>; resolve: <T = unknown>(type: string, id: string, options?: SavedObjectsBaseOptions) => Promise<SavedObjectsResolveResponse<T>>; addToNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsAddToNamespacesOptions) => Promise<SavedObjectsAddToNamespacesResponse>; deleteFromNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions) => Promise<SavedObjectsDeleteFromNamespacesResponse>; removeReferencesTo: (type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions) => Promise<SavedObjectsRemoveReferencesToResponse>; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions) => Promise<SavedObjectsOpenPointInTimeResponse>; closePointInTime: (id: string, options?: SavedObjectsBaseOptions | undefined) => Promise<SavedObjectsClosePointInTimeResponse>; deleteByNamespace: (namespace: string, options?: SavedObjectsDeleteByNamespaceOptions) => Promise<any>; incrementCounter: <T>(type: string, id: string, counterFields: (string | SavedObjectsIncrementCounterField)[], options?: SavedObjectsIncrementCounterOptions) => Promise<SavedObject<T>>; }"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsFieldMapping",
"type": "Type",
"label": "SavedObjectsFieldMapping",
"tags": [
"public"
],
"description": [
"\nDescribe a {@link SavedObjectsTypeMappingDefinition | saved object type mapping} field.\n\nPlease refer to {@link https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html | elasticsearch documentation}\nFor the mapping documentation\n"
],
"source": {
"path": "src/core/server/saved_objects/mappings/types.ts",
"lineNumber": 99,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L99"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsComplexFieldMapping",
"text": "SavedObjectsComplexFieldMapping"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCoreFieldMapping",
"text": "SavedObjectsCoreFieldMapping"
}
],
"initialIsOpen": false
},
{
"id": "def-server.ISavedObjectTypeRegistry",
"type": "Type",
"label": "ISavedObjectTypeRegistry",
"tags": [
"public"
],
"description": [
"\nSee {@link SavedObjectTypeRegistry} for documentation.\n"
],
"source": {
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L17"
},
"signature": [
"{ getType: (type: string) => SavedObjectsType | undefined; getVisibleTypes: () => SavedObjectsType[]; getAllTypes: () => SavedObjectsType[]; getImportableAndExportableTypes: () => SavedObjectsType[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsNamespaceType",
"type": "Type",
"label": "SavedObjectsNamespaceType",
"tags": [
"public"
],
"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"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 226,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L226"
},
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectMigrationFn",
"type": "Type",
"label": "SavedObjectMigrationFn",
"tags": [
"example",
"public"
],
"description": [
"\nA migration function for a {@link SavedObjectsType | saved object type}\nused to migrate it to a given version\n"
],
"source": {
"path": "src/core/server/saved_objects/migrations/types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L45"
},
"signature": [
"(doc: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes>, context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectMigrationContext",
"text": "SavedObjectMigrationContext"
},
") => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>"
],
"initialIsOpen": false
},
{
"id": "def-server.ISavedObjectsExporter",
"type": "Type",
"label": "ISavedObjectsExporter",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L32"
},
"signature": [
"{ exportByTypes: (options: SavedObjectsExportByTypeOptions) => Promise<",
"Readable",
">; exportByObjects: (options: SavedObjectsExportByObjectOptions) => Promise<",
"Readable",
">; }"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsExportTransform",
"type": "Type",
"label": "SavedObjectsExportTransform",
"tags": [
"example",
"example",
"remarks",
"public"
],
"description": [
"\nTransformation function used to mutate the exported objects of the associated type.\n\nA type's export transform function will be executed once per user-initiated export,\nfor all objects of that type.\n"
],
"source": {
"path": "src/core/server/saved_objects/export/types.ts",
"lineNumber": 155,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L155"
},
"signature": [
"(context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportTransformContext",
"text": "SavedObjectsExportTransformContext"
},
", objects: ",
"SavedObject",
"<T>[]) => ",
"SavedObject",
"<unknown>[] | Promise<",
"SavedObject",
"<unknown>[]>"
],
"initialIsOpen": false
},
{
"id": "def-server.ISavedObjectsImporter",
"type": "Type",
"label": "ISavedObjectsImporter",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L24"
},
"signature": [
"{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise<SavedObjectsImportResponse>; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise<SavedObjectsImportResponse>; }"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportHook",
"type": "Type",
"label": "SavedObjectsImportHook",
"tags": [
"remark",
"public"
],
"description": [
"\nA hook associated with a specific saved object type, that will be invoked during\nthe import process. The hook will have access to the objects of the registered type.\n\nCurrently, the only supported feature for import hooks is to return warnings to be displayed\nin the UI when the import succeeds.\n"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 246,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L246"
},
"signature": [
"(objects: ",
"SavedObject",
"<T>[]) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportHookResult",
"text": "SavedObjectsImportHookResult"
},
" | Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportHookResult",
"text": "SavedObjectsImportHookResult"
},
">"
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsImportWarning",
"type": "Type",
"label": "SavedObjectsImportWarning",
"tags": [
"public"
],
"description": [
"\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n"
],
"source": {
"path": "src/core/server/saved_objects/import/types.ts",
"lineNumber": 218,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L218"
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportSimpleWarning",
"text": "SavedObjectsImportSimpleWarning"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportActionRequiredWarning",
"text": "SavedObjectsImportActionRequiredWarning"
}
],
"initialIsOpen": false
},
{
"id": "def-server.MutatingOperationRefreshSetting",
"type": "Type",
"label": "MutatingOperationRefreshSetting",
"tags": [
"public"
],
"description": [
"\nElasticsearch Refresh setting for mutating operation"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 148,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L148"
},
"signature": [
"false | true | \"wait_for\""
],
"initialIsOpen": false
},
{
"id": "def-server.SavedObjectsClientContract",
"type": "Type",
"label": "SavedObjectsClientContract",
"tags": [
"public"
],
"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 persistance 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"
],
"source": {
"path": "src/core/server/saved_objects/types.ts",
"lineNumber": 212,
"link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L212"
},
"signature": [
"{ get: <T = unknown>(type: string, id: string, options?: SavedObjectsBaseOptions) => Promise<SavedObject<T>>; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; create: <T>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<SavedObject<T>>; find: <T = unknown>(options: SavedObjectsFindOptions) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
}
],
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink