maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/core_saved_objects.json
Stacey Gammon 45e9d51a44
Add pluginTeam to plugin API ci stats (#115007) 
* Add pluginTeam to ci stats for easier higher level groupings

* Updated docs
2021-10-14 11:54:35 -04:00

17029 lines
652 KiB
JSON
Raw Blame History

{
"id": "core.savedObjects",
"client": {
"classes": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient",
"type": "Class",
"tags": [],
"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"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [
"\nPersists an object\n"
],
"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>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.create.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.create.$2",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.create.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkCreate",
"type": "Function",
"tags": [
"property"
],
"label": "bulkCreate",
"description": [
"\nCreates multiple documents at once\n"
],
"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>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkCreate.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- [{ type, id, attributes, references, migrationVersion }]"
],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<unknown>[]"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkCreate.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkCreateOptions",
"text": "SavedObjectsBulkCreateOptions"
}
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The result of the create operation containing created saved objects."
]
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.delete",
"type": "Function",
"tags": [],
"label": "delete",
"description": [
"\nDeletes an object\n"
],
"signature": [
"(type: string, id: string, options?: ",
"SavedObjectsDeleteOptions",
" | undefined) => Promise<{}>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.delete.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.delete.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.delete.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"SavedObjectsDeleteOptions",
" | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.find",
"type": "Function",
"tags": [
"property",
"property",
"property",
"property",
"property",
"property",
"property"
],
"label": "find",
"description": [
"\nSearch for objects\n"
],
"signature": [
"<T = unknown, A = unknown>(options: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsFindResponsePublic",
"text": "SavedObjectsFindResponsePublic"
},
"<T, unknown>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.find.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"A find result with objects matching the specified search."
]
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [
"\nFetches a single object\n"
],
"signature": [
"<T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.get.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.get.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The saved object for the given type and id."
]
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkGet",
"type": "Function",
"tags": [],
"label": "bulkGet",
"description": [
"\nReturns an array of objects by id\n"
],
"signature": [
"(objects?: { id: string; type: string; }[]) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<unknown>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkGet.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- an array ids, or an array of objects containing id and optionally type"
],
"signature": [
"{ id: string; type: string; }[]"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The saved objects with the given type and ids requested"
]
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.resolve",
"type": "Function",
"tags": [
"note"
],
"label": "resolve",
"description": [
"\nResolves a single object\n"
],
"signature": [
"<T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.ResolvedSimpleSavedObject",
"text": "ResolvedSimpleSavedObject"
},
"<T>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.resolve.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.resolve.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The resolve result for the saved object for the given type and id."
]
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkResolve",
"type": "Function",
"tags": [
"note"
],
"label": "bulkResolve",
"description": [
"\nResolves an array of objects by id, using any legacy URL aliases if they exist\n"
],
"signature": [
"<T = unknown>(objects?: { id: string; type: string; }[]) => Promise<{ resolved_objects: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.ResolvedSimpleSavedObject",
"text": "ResolvedSimpleSavedObject"
},
"<T>[]; }>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkResolve.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- an array of objects containing id, type"
],
"signature": [
"{ id: string; type: string; }[]"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The bulk resolve result for the saved objects for the given types and ids."
]
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.update",
"type": "Function",
"tags": [
"prop",
"prop"
],
"label": "update",
"description": [
"\nUpdates an object\n"
],
"signature": [
"<T = unknown>(type: string, id: string, attributes: T, { version, references, upsert }?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<unknown>) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.update.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.update.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.update.$3",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.update.$4",
"type": "Object",
"tags": [],
"label": "{ version, references, upsert }",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<unknown>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkUpdate",
"type": "Function",
"tags": [],
"label": "bulkUpdate",
"description": [
"\nUpdate multiple documents at once\n"
],
"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>>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClient.bulkUpdate.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- [{ type, id, attributes, options: { version, references } }]"
],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<unknown>[]"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The result of the update operation containing both failed and updated saved objects."
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject",
"type": "Class",
"tags": [],
"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>"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.attributes",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject._version",
"type": "string",
"tags": [],
"label": "_version",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.migrationVersion",
"type": "Object",
"tags": [],
"label": "migrationVersion",
"description": [],
"signature": [
"SavedObjectsMigrationVersion",
" | undefined"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.coreMigrationVersion",
"type": "string",
"tags": [],
"label": "coreMigrationVersion",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.error",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"SavedObjectError",
" | undefined"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[]"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.namespaces",
"type": "Array",
"tags": [],
"label": "namespaces",
"description": [
"\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"bulkUpdate\">"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n namespaces,\n }",
"description": [],
"signature": [
"SavedObject",
"<T>"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(key: string) => any"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.get.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.set",
"type": "Function",
"tags": [],
"label": "set",
"description": [],
"signature": [
"(key: string, value: any) => T"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.set.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.set.$2",
"type": "Any",
"tags": [],
"label": "value",
"description": [],
"signature": [
"any"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.has",
"type": "Function",
"tags": [],
"label": "has",
"description": [],
"signature": [
"(key: string) => boolean"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.has.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.save",
"type": "Function",
"tags": [],
"label": "save",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-public.SimpleSavedObject.delete",
"type": "Function",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"() => Promise<{}>"
],
"path": "src/core/public/saved_objects/simple_saved_object.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "core",
"id": "def-public.ResolvedSimpleSavedObject",
"type": "Interface",
"tags": [],
"label": "ResolvedSimpleSavedObject",
"description": [
"\nThis interface is a very simple wrapper for SavedObjects resolved from the server\nwith the {@link SavedObjectsClient}.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.ResolvedSimpleSavedObject",
"text": "ResolvedSimpleSavedObject"
},
"<T>"
],
"path": "src/core/public/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.ResolvedSimpleSavedObject.saved_object",
"type": "Object",
"tags": [],
"label": "saved_object",
"description": [
"\nThe saved object that was found."
],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>"
],
"path": "src/core/public/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.ResolvedSimpleSavedObject.outcome",
"type": "CompoundType",
"tags": [],
"label": "outcome",
"description": [
"\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID."
],
"signature": [
"\"conflict\" | \"exactMatch\" | \"aliasMatch\""
],
"path": "src/core/public/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.ResolvedSimpleSavedObject.alias_target_id",
"type": "string",
"tags": [],
"label": "alias_target_id",
"description": [
"\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`."
],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBatchResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBatchResponse",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<T>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBatchResponse.savedObjects",
"type": "Array",
"tags": [],
"label": "savedObjects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>[]"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkCreateObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkCreateObject",
"description": [],
"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"
}
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkCreateObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkCreateObject.attributes",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkCreateOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkCreateOptions",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkCreateOptions.overwrite",
"type": "CompoundType",
"tags": [],
"label": "overwrite",
"description": [
"If a document with the given `id` already exists, overwrite it's contents (default=false)."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkUpdateObject",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateObject.attributes",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateObject.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateObject.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[] | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkUpdateOptions",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsBulkUpdateOptions.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsCreateOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCreateOptions",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsCreateOptions.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\n(Not recommended) Specify an id instead of having the saved objects service generate one for you."
],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsCreateOptions.overwrite",
"type": "CompoundType",
"tags": [],
"label": "overwrite",
"description": [
"If a document with the given `id` already exists, overwrite it's contents (default=false)."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsCreateOptions.migrationVersion",
"type": "Object",
"tags": [],
"label": "migrationVersion",
"description": [
"{@inheritDoc SavedObjectsMigrationVersion}"
],
"signature": [
"SavedObjectsMigrationVersion",
" | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion",
"type": "string",
"tags": [],
"label": "coreMigrationVersion",
"description": [
"A semver value that is used when upgrading objects between Kibana versions."
],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsCreateOptions.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[] | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsFindResponsePublic",
"type": "Interface",
"tags": [],
"label": "SavedObjectsFindResponsePublic",
"description": [
"\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsFindResponsePublic",
"text": "SavedObjectsFindResponsePublic"
},
"<T, A> extends ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<T>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsFindResponsePublic.aggregations",
"type": "Uncategorized",
"tags": [],
"label": "aggregations",
"description": [],
"signature": [
"A | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsFindResponsePublic.total",
"type": "number",
"tags": [],
"label": "total",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsFindResponsePublic.perPage",
"type": "number",
"tags": [],
"label": "perPage",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsFindResponsePublic.page",
"type": "number",
"tags": [],
"label": "page",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsStart",
"type": "Interface",
"tags": [],
"label": "SavedObjectsStart",
"description": [],
"path": "src/core/public/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsStart.client",
"type": "Object",
"tags": [],
"label": "client",
"description": [
"{@link SavedObjectsClient}"
],
"signature": [
"{ create: <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>>; bulkCreate: (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>>; delete: (type: string, id: string, options?: ",
"SavedObjectsDeleteOptions",
" | undefined) => Promise<{}>; find: <T = unknown, A = unknown>(options: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsFindResponsePublic",
"text": "SavedObjectsFindResponsePublic"
},
"<T, unknown>>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<unknown>>; bulkResolve: <T = unknown>(objects?: { id: string; type: string; }[]) => Promise<{ resolved_objects: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.ResolvedSimpleSavedObject",
"text": "ResolvedSimpleSavedObject"
},
"<T>[]; }>; get: <T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>; resolve: <T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.ResolvedSimpleSavedObject",
"text": "ResolvedSimpleSavedObject"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: T, { version, references, upsert }?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<unknown>) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>; bulkUpdate: <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>>; }"
],
"path": "src/core/public/saved_objects/saved_objects_service.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsUpdateOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsUpdateOptions",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<Attributes>"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsUpdateOptions.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsUpdateOptions.upsert",
"type": "Uncategorized",
"tags": [],
"label": "upsert",
"description": [],
"signature": [
"Attributes | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsUpdateOptions.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[] | undefined"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "core",
"id": "def-public.SavedObjectsClientContract",
"type": "Type",
"tags": [],
"label": "SavedObjectsClientContract",
"description": [
"\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n"
],
"signature": [
"{ create: <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>>; bulkCreate: (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>>; delete: (type: string, id: string, options?: ",
"SavedObjectsDeleteOptions",
" | undefined) => Promise<{}>; find: <T = unknown, A = unknown>(options: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"page\" | \"perPage\" | \"sortField\" | \"search\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsFindResponsePublic",
"text": "SavedObjectsFindResponsePublic"
},
"<T, unknown>>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsBatchResponse",
"text": "SavedObjectsBatchResponse"
},
"<unknown>>; bulkResolve: <T = unknown>(objects?: { id: string; type: string; }[]) => Promise<{ resolved_objects: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.ResolvedSimpleSavedObject",
"text": "ResolvedSimpleSavedObject"
},
"<T>[]; }>; get: <T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>; resolve: <T = unknown>(type: string, id: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.ResolvedSimpleSavedObject",
"text": "ResolvedSimpleSavedObject"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: T, { version, references, upsert }?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<unknown>) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<T>>; bulkUpdate: <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>>; }"
],
"path": "src/core/public/saved_objects/saved_objects_client.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient",
"type": "Class",
"tags": [],
"label": "SavedObjectsClient",
"description": [
"\n"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [
"\nPersists a SavedObject\n"
],
"signature": [
"<T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.create.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.create.$2",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.create.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkCreate",
"type": "Function",
"tags": [],
"label": "bulkCreate",
"description": [
"\nPersists multiple documents batched together as a single request\n"
],
"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>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkCreate.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkCreate.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.checkConflicts",
"type": "Function",
"tags": [],
"label": "checkConflicts",
"description": [
"\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n"
],
"signature": [
"(objects?: ",
{
"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"
},
">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.checkConflicts.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.checkConflicts.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.delete",
"type": "Function",
"tags": [],
"label": "delete",
"description": [
"\nDeletes a SavedObject\n"
],
"signature": [
"(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.delete.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.delete.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.delete.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.find",
"type": "Function",
"tags": [],
"label": "find",
"description": [
"\nFind all SavedObjects matching the search query\n"
],
"signature": [
"<T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.find.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkGet",
"type": "Function",
"tags": [],
"label": "bulkGet",
"description": [
"\nReturns an array of objects by id\n"
],
"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>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkGet.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- an array of ids, or an array of objects containing id, type and optionally fields"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkGet.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [
"\nRetrieves a single object\n"
],
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.get.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [
"- The type of SavedObject to retrieve"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.get.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- The ID of the SavedObject to retrieve"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.get.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkResolve",
"type": "Function",
"tags": [
"note"
],
"label": "bulkResolve",
"description": [
"\nResolves an array of objects by id, using any legacy URL aliases if they exist\n"
],
"signature": [
"<T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkResolve.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- an array of objects containing id, type"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkResolve.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.resolve",
"type": "Function",
"tags": [],
"label": "resolve",
"description": [
"\nResolves a single object, using any legacy URL alias if it exists\n"
],
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"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>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.resolve.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [
"- The type of SavedObject to retrieve"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.resolve.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- The ID of the SavedObject to retrieve"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.resolve.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [
"\nUpdates an SavedObject\n"
],
"signature": [
"<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.update.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.update.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.update.$3",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"Partial<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.update.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkUpdate",
"type": "Function",
"tags": [],
"label": "bulkUpdate",
"description": [
"\nBulk Updates multiple SavedObject at once\n"
],
"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>>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkUpdate.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.bulkUpdate.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.removeReferencesTo",
"type": "Function",
"tags": [],
"label": "removeReferencesTo",
"description": [
"\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference."
],
"signature": [
"(type: string, id: string, options?: ",
{
"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"
},
">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.removeReferencesTo.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.removeReferencesTo.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.removeReferencesTo.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.openPointInTimeForType",
"type": "Function",
"tags": [],
"label": "openPointInTimeForType",
"description": [
"\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method."
],
"signature": [
"(type: string | string[], options?: ",
{
"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"
},
">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.openPointInTimeForType.$1",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | string[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.openPointInTimeForType.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.closePointInTime",
"type": "Function",
"tags": [],
"label": "closePointInTime",
"description": [
"\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method."
],
"signature": [
"(id: string, options?: ",
{
"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"
},
">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.closePointInTime.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.closePointInTime.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.createPointInTimeFinder",
"type": "Function",
"tags": [],
"label": "createPointInTimeFinder",
"description": [
"\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThe generator wraps calls to {@link SavedObjectsClient.find} and iterates\nover multiple pages of results using `_pit` and `search_after`. This will\nopen a new Point-In-Time (PIT), and continue paging until a set of\nresults is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n"
],
"signature": [
"<T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.createPointInTimeFinder.$1",
"type": "Object",
"tags": [],
"label": "findOptions",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.createPointInTimeFinder.$2",
"type": "Object",
"tags": [],
"label": "dependencies",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.collectMultiNamespaceReferences",
"type": "Function",
"tags": [],
"label": "collectMultiNamespaceReferences",
"description": [
"\nGets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type.\n"
],
"signature": [
"(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.collectMultiNamespaceReferences.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.collectMultiNamespaceReferences.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.updateObjectsSpaces",
"type": "Function",
"tags": [],
"label": "updateObjectsSpaces",
"description": [
"\nUpdates one or more objects to add and/or remove them from specified spaces.\n"
],
"signature": [
"(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.updateObjectsSpaces.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.updateObjectsSpaces.$2",
"type": "Array",
"tags": [],
"label": "spacesToAdd",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.updateObjectsSpaces.$3",
"type": "Array",
"tags": [],
"label": "spacesToRemove",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClient.updateObjectsSpaces.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers",
"type": "Class",
"tags": [],
"label": "SavedObjectsErrorHelpers",
"description": [],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError",
"type": "Function",
"tags": [],
"label": "isSavedObjectsClientError",
"description": [],
"signature": [
"(error: any) => error is ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError.$1",
"type": "Any",
"tags": [],
"label": "error",
"description": [],
"signature": [
"any"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError",
"type": "Function",
"tags": [],
"label": "decorateBadRequestError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createBadRequestError",
"type": "Function",
"tags": [],
"label": "createBadRequestError",
"description": [],
"signature": [
"(reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createBadRequestError.$1",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError",
"type": "Function",
"tags": [],
"label": "createUnsupportedTypeError",
"description": [],
"signature": [
"(type: string) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isBadRequestError",
"type": "Function",
"tags": [],
"label": "isBadRequestError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isBadRequestError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError",
"type": "Function",
"tags": [],
"label": "createInvalidVersionError",
"description": [],
"signature": [
"(versionInput?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError.$1",
"type": "string",
"tags": [],
"label": "versionInput",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError",
"type": "Function",
"tags": [],
"label": "isInvalidVersionError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError",
"type": "Function",
"tags": [],
"label": "decorateNotAuthorizedError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError",
"type": "Function",
"tags": [],
"label": "isNotAuthorizedError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError",
"type": "Function",
"tags": [],
"label": "decorateForbiddenError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isForbiddenError",
"type": "Function",
"tags": [],
"label": "isForbiddenError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isForbiddenError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError",
"type": "Function",
"tags": [],
"label": "decorateRequestEntityTooLargeError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError",
"type": "Function",
"tags": [],
"label": "isRequestEntityTooLargeError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError",
"type": "Function",
"tags": [],
"label": "createGenericNotFoundError",
"description": [],
"signature": [
"(type?: string | null, id?: string | null) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$1",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | null"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$2",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError",
"type": "Function",
"tags": [],
"label": "createIndexAliasNotFoundError",
"description": [],
"signature": [
"(alias: string) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError.$1",
"type": "string",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError",
"type": "Function",
"tags": [],
"label": "decorateIndexAliasNotFoundError",
"description": [],
"signature": [
"(error: Error, alias: string) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$2",
"type": "string",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isNotFoundError",
"type": "Function",
"tags": [],
"label": "isNotFoundError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isNotFoundError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateConflictError",
"type": "Function",
"tags": [],
"label": "decorateConflictError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createConflictError",
"type": "Function",
"tags": [],
"label": "createConflictError",
"description": [],
"signature": [
"(type: string, id: string, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createConflictError.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createConflictError.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createConflictError.$3",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isConflictError",
"type": "Function",
"tags": [],
"label": "isConflictError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isConflictError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError",
"type": "Function",
"tags": [],
"label": "decorateTooManyRequestsError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError",
"type": "Function",
"tags": [],
"label": "createTooManyRequestsError",
"description": [],
"signature": [
"(type: string, id: string) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError",
"type": "Function",
"tags": [],
"label": "isTooManyRequestsError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError",
"type": "Function",
"tags": [],
"label": "decorateEsCannotExecuteScriptError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError",
"type": "Function",
"tags": [],
"label": "isEsCannotExecuteScriptError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError",
"type": "Function",
"tags": [],
"label": "decorateEsUnavailableError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError",
"type": "Function",
"tags": [],
"label": "isEsUnavailableError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError",
"type": "Function",
"tags": [],
"label": "decorateGeneralError",
"description": [],
"signature": [
"(error: Error, reason?: string | undefined) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$1",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$2",
"type": "string",
"tags": [],
"label": "reason",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isGeneralError",
"type": "Function",
"tags": [],
"label": "isGeneralError",
"description": [],
"signature": [
"(error: Error | ",
"DecoratedError",
") => boolean"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.isGeneralError.$1",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error | ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError",
"type": "Function",
"tags": [],
"label": "createGenericNotFoundEsUnavailableError",
"description": [],
"signature": [
"(type?: string | null, id?: string | null) => ",
"DecoratedError"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$1",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | null"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$2",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null"
],
"path": "src/core/server/saved_objects/service/lib/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter",
"type": "Class",
"tags": [],
"label": "SavedObjectsExporter",
"description": [],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.savedObjectsClient",
"type": "Object",
"tags": [],
"label": "#savedObjectsClient",
"description": [],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; errors: typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
"; }"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.exportSizeLimit",
"type": "number",
"tags": [],
"label": "#exportSizeLimit",
"description": [],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.typeRegistry",
"type": "Object",
"tags": [],
"label": "#typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined; getVisibleTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getAllTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getImportableAndExportableTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; 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; }"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.log",
"type": "Object",
"tags": [],
"label": "#log",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }",
"description": [],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.Unnamed.$1.savedObjectsClient",
"type": "Object",
"tags": [],
"label": "savedObjectsClient",
"description": [],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; errors: typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
"; }"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.Unnamed.$1.typeRegistry",
"type": "Object",
"tags": [],
"label": "typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined; getVisibleTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getAllTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getImportableAndExportableTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; 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; }"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.Unnamed.$1.exportSizeLimit",
"type": "number",
"tags": [],
"label": "exportSizeLimit",
"description": [],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.Unnamed.$1.logger",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.exportByTypes",
"type": "Function",
"tags": [
"throws"
],
"label": "exportByTypes",
"description": [
"\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n"
],
"signature": [
"(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByTypeOptions",
"text": "SavedObjectsExportByTypeOptions"
},
") => Promise<",
"Readable",
">"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.exportByTypes.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByTypeOptions",
"text": "SavedObjectsExportByTypeOptions"
}
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.exportByObjects",
"type": "Function",
"tags": [
"throws"
],
"label": "exportByObjects",
"description": [
"\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n"
],
"signature": [
"(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByObjectOptions",
"text": "SavedObjectsExportByObjectOptions"
},
") => Promise<",
"Readable",
">"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExporter.exportByObjects.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByObjectOptions",
"text": "SavedObjectsExportByObjectOptions"
}
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError",
"type": "Class",
"tags": [],
"label": "SavedObjectsExportError",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
},
" extends Error"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.Unnamed.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.Unnamed.$2",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.Unnamed.$3",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"Record<string, any> | undefined"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.exportSizeExceeded",
"type": "Function",
"tags": [],
"label": "exportSizeExceeded",
"description": [],
"signature": [
"(limit: number) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
}
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1",
"type": "number",
"tags": [],
"label": "limit",
"description": [],
"signature": [
"number"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.objectFetchError",
"type": "Function",
"tags": [],
"label": "objectFetchError",
"description": [],
"signature": [
"(objects: ",
"SavedObject",
"<unknown>[]) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
}
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.objectFetchError.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
"SavedObject",
"<unknown>[]"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.objectTransformError",
"type": "Function",
"tags": [],
"label": "objectTransformError",
"description": [
"\nError returned when a {@link SavedObjectsExportTransform | export transform} threw an error"
],
"signature": [
"(objects: ",
"SavedObject",
"<unknown>[], cause: Error) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
}
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.objectTransformError.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
"SavedObject",
"<unknown>[]"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.objectTransformError.$2",
"type": "Object",
"tags": [],
"label": "cause",
"description": [],
"signature": [
"Error"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.invalidTransformError",
"type": "Function",
"tags": [],
"label": "invalidTransformError",
"description": [
"\nError returned when a {@link SavedObjectsExportTransform | export transform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id."
],
"signature": [
"(objectKeys: string[]) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportError",
"text": "SavedObjectsExportError"
}
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportError.invalidTransformError.$1",
"type": "Array",
"tags": [],
"label": "objectKeys",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/export/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter",
"type": "Class",
"tags": [],
"label": "SavedObjectsImporter",
"description": [],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.savedObjectsClient",
"type": "Object",
"tags": [],
"label": "#savedObjectsClient",
"description": [],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; errors: typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
"; }"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.typeRegistry",
"type": "Object",
"tags": [],
"label": "#typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined; getVisibleTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getAllTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getImportableAndExportableTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; 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; }"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.importSizeLimit",
"type": "number",
"tags": [],
"label": "#importSizeLimit",
"description": [],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.importHooks",
"type": "Object",
"tags": [],
"label": "#importHooks",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportHook",
"text": "SavedObjectsImportHook"
},
"<unknown>[]; }"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }",
"description": [],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.Unnamed.$1.savedObjectsClient",
"type": "Object",
"tags": [],
"label": "savedObjectsClient",
"description": [],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; errors: typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
"; }"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.Unnamed.$1.typeRegistry",
"type": "Object",
"tags": [],
"label": "typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined; getVisibleTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getAllTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getImportableAndExportableTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; 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; }"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.Unnamed.$1.importSizeLimit",
"type": "number",
"tags": [],
"label": "importSizeLimit",
"description": [],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.import",
"type": "Function",
"tags": [
"throws"
],
"label": "import",
"description": [
"\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n"
],
"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"
},
">"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.import.$1",
"type": "Object",
"tags": [],
"label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportOptions",
"text": "SavedObjectsImportOptions"
}
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.resolveImportErrors",
"type": "Function",
"tags": [
"throws"
],
"label": "resolveImportErrors",
"description": [
"\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed information.\n"
],
"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"
},
">"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImporter.resolveImportErrors.$1",
"type": "Object",
"tags": [],
"label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveImportErrorsOptions",
"text": "SavedObjectsResolveImportErrorsOptions"
}
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError",
"type": "Class",
"tags": [],
"label": "SavedObjectsImportError",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
},
" extends Error"
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.importSizeExceeded",
"type": "Function",
"tags": [],
"label": "importSizeExceeded",
"description": [],
"signature": [
"(limit: number) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
}
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.importSizeExceeded.$1",
"type": "number",
"tags": [],
"label": "limit",
"description": [],
"signature": [
"number"
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.nonUniqueImportObjects",
"type": "Function",
"tags": [],
"label": "nonUniqueImportObjects",
"description": [],
"signature": [
"(nonUniqueEntries: string[]) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
}
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.nonUniqueImportObjects.$1",
"type": "Array",
"tags": [],
"label": "nonUniqueEntries",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects",
"type": "Function",
"tags": [],
"label": "nonUniqueRetryObjects",
"description": [],
"signature": [
"(nonUniqueRetryObjects: string[]) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
}
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects.$1",
"type": "Array",
"tags": [],
"label": "nonUniqueRetryObjects",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations",
"type": "Function",
"tags": [],
"label": "nonUniqueRetryDestinations",
"description": [],
"signature": [
"(nonUniqueRetryDestinations: string[]) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
}
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1",
"type": "Array",
"tags": [],
"label": "nonUniqueRetryDestinations",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.referencesFetchError",
"type": "Function",
"tags": [],
"label": "referencesFetchError",
"description": [],
"signature": [
"(objects: ",
"SavedObject",
"<unknown>[]) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportError",
"text": "SavedObjectsImportError"
}
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportError.referencesFetchError.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
"SavedObject",
"<unknown>[]"
],
"path": "src/core/server/saved_objects/import/errors.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository",
"type": "Class",
"tags": [],
"label": "SavedObjectsRepository",
"description": [],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.create",
"type": "Function",
"tags": [
"property",
"property",
"property",
"property",
"property"
],
"label": "create",
"description": [
"\nPersists an object\n"
],
"signature": [
"<T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
") => Promise<",
"SavedObject",
"<T>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.create.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.create.$2",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.create.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { id, type, version, attributes }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkCreate",
"type": "Function",
"tags": [
"property",
"property"
],
"label": "bulkCreate",
"description": [
"\nCreates multiple documents at once\n"
],
"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>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkCreate.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- [{ type, id, attributes, references, migrationVersion }]"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkCreate.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.checkConflicts",
"type": "Function",
"tags": [],
"label": "checkConflicts",
"description": [
"\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten."
],
"signature": [
"(objects?: ",
{
"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"
},
">"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.checkConflicts.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.checkConflicts.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.delete",
"type": "Function",
"tags": [
"property"
],
"label": "delete",
"description": [
"\nDeletes an object\n"
],
"signature": [
"(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.delete.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.delete.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.delete.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.deleteByNamespace",
"type": "Function",
"tags": [],
"label": "deleteByNamespace",
"description": [
"\nDeletes all objects from the provided namespace.\n"
],
"signature": [
"(namespace: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteByNamespaceOptions",
"text": "SavedObjectsDeleteByNamespaceOptions"
},
") => Promise<any>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.deleteByNamespace.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.deleteByNamespace.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteByNamespaceOptions",
"text": "SavedObjectsDeleteByNamespaceOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.find",
"type": "Function",
"tags": [
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property",
"property"
],
"label": "find",
"description": [],
"signature": [
"<T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.find.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkGet",
"type": "Function",
"tags": [
"property"
],
"label": "bulkGet",
"description": [
"\nReturns an array of objects by id\n"
],
"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>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkGet.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- an array of objects containing id, type and optionally fields"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkGet.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { saved_objects: [{ id, type, version, attributes }] }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkResolve",
"type": "Function",
"tags": [
"property"
],
"label": "bulkResolve",
"description": [
"\nResolves an array of objects by id, using any legacy URL aliases if they exist\n"
],
"signature": [
"<T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkResolve.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- an array of objects containing id, type"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkResolve.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { resolved_objects: [{ saved_object, outcome }] }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.get",
"type": "Function",
"tags": [
"property"
],
"label": "get",
"description": [
"\nGets a single object\n"
],
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.get.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.get.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.get.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { id, type, version, attributes }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.resolve",
"type": "Function",
"tags": [
"property"
],
"label": "resolve",
"description": [
"\nResolves a single object, using any legacy URL alias if it exists\n"
],
"signature": [
"<T = unknown>(type: string, id: string, options?: ",
{
"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>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.resolve.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.resolve.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.resolve.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { saved_object, outcome }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.update",
"type": "Function",
"tags": [
"property",
"property",
"property"
],
"label": "update",
"description": [
"\nUpdates an object\n"
],
"signature": [
"<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.update.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.update.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.update.$3",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"Partial<T>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.update.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences",
"type": "Function",
"tags": [],
"label": "collectMultiNamespaceReferences",
"description": [
"\nGets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace\ntype.\n"
],
"signature": [
"(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"The objects to get the references for."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.updateObjectsSpaces",
"type": "Function",
"tags": [],
"label": "updateObjectsSpaces",
"description": [
"\nUpdates one or more objects to add and/or remove them from specified spaces.\n"
],
"signature": [
"(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$2",
"type": "Array",
"tags": [],
"label": "spacesToAdd",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$3",
"type": "Array",
"tags": [],
"label": "spacesToRemove",
"description": [],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkUpdate",
"type": "Function",
"tags": [
"property",
"property"
],
"label": "bulkUpdate",
"description": [
"\nUpdates multiple objects in bulk\n"
],
"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>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkUpdate.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"- [{ type, id, attributes, options: { version, namespace } references }]"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.bulkUpdate.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.removeReferencesTo",
"type": "Function",
"tags": [],
"label": "removeReferencesTo",
"description": [
"\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n"
],
"signature": [
"(type: string, id: string, options?: ",
{
"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"
},
">"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.removeReferencesTo.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.removeReferencesTo.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.removeReferencesTo.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.incrementCounter",
"type": "Function",
"tags": [],
"label": "incrementCounter",
"description": [
"\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n"
],
"signature": [
"<T = unknown>(type: string, id: string, counterFields: (string | ",
{
"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"
},
"<T> | undefined) => Promise<",
"SavedObject",
"<T>>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.incrementCounter.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [
"- The type of saved object whose fields should be incremented"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.incrementCounter.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- The id of the document whose fields should be incremented"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.incrementCounter.$3",
"type": "Array",
"tags": [],
"label": "counterFields",
"description": [
"- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}"
],
"signature": [
"(string | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterField",
"text": "SavedObjectsIncrementCounterField"
},
")[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.incrementCounter.$4",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"- {@link SavedObjectsIncrementCounterOptions}"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterOptions",
"text": "SavedObjectsIncrementCounterOptions"
},
"<T> | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [
"The saved object after the specified fields were incremented"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.openPointInTimeForType",
"type": "Function",
"tags": [
"property",
"property"
],
"label": "openPointInTimeForType",
"description": [
"\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n"
],
"signature": [
"(type: string | string[], { 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"
},
">"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.openPointInTimeForType.$1",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | string[]"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.openPointInTimeForType.$2",
"type": "Object",
"tags": [],
"label": "{ keepAlive = '5m', preference }",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"- { id: string }"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.closePointInTime",
"type": "Function",
"tags": [],
"label": "closePointInTime",
"description": [
"\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n"
],
"signature": [
"(id: string, options?: ",
{
"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"
},
">"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.closePointInTime.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.closePointInTime.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"- {@link SavedObjectsClosePointInTimeOptions}"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [
"- {@link SavedObjectsClosePointInTimeResponse}"
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.createPointInTimeFinder",
"type": "Function",
"tags": [],
"label": "createPointInTimeFinder",
"description": [
"\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n"
],
"signature": [
"<T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$1",
"type": "Object",
"tags": [],
"label": "findOptions",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2",
"type": "Object",
"tags": [],
"label": "dependencies",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer",
"type": "Class",
"tags": [],
"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"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.isRawSavedObject",
"type": "Function",
"tags": [],
"label": "isRawSavedObject",
"description": [
"\nDetermines whether or not the raw document can be converted to a saved object.\n"
],
"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"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.isRawSavedObject.$1",
"type": "Object",
"tags": [],
"label": "doc",
"description": [
"- The raw ES document to be tested"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDoc",
"text": "SavedObjectsRawDoc"
}
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.isRawSavedObject.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"- Options for parsing the raw document."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDocParseOptions",
"text": "SavedObjectsRawDocParseOptions"
}
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.rawToSavedObject",
"type": "Function",
"tags": [],
"label": "rawToSavedObject",
"description": [
"\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n"
],
"signature": [
"<T = unknown>(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"
},
"<T>"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.rawToSavedObject.$1",
"type": "Object",
"tags": [],
"label": "doc",
"description": [
"- The raw ES document to be converted to saved object format."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDoc",
"text": "SavedObjectsRawDoc"
}
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.rawToSavedObject.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"- Options for parsing the raw document."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRawDocParseOptions",
"text": "SavedObjectsRawDocParseOptions"
}
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.savedObjectToRaw",
"type": "Function",
"tags": [],
"label": "savedObjectToRaw",
"description": [
"\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.savedObjectToRaw.$1",
"type": "CompoundType",
"tags": [],
"label": "savedObj",
"description": [
"- The saved object to be converted to raw ES format."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectSanitizedDoc",
"text": "SavedObjectSanitizedDoc"
},
"<unknown>"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawId",
"type": "Function",
"tags": [],
"label": "generateRawId",
"description": [
"\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n"
],
"signature": [
"(namespace: string | undefined, type: string, id: string) => string"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawId.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"- The namespace of the saved object"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawId.$2",
"type": "string",
"tags": [],
"label": "type",
"description": [
"- The saved object type"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawId.$3",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- The id of the saved object"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId",
"type": "Function",
"tags": [],
"label": "generateRawLegacyUrlAliasId",
"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"
],
"signature": [
"(namespace: string, type: string, id: string) => string"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"- The namespace of the saved object"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$2",
"type": "string",
"tags": [],
"label": "type",
"description": [
"- The saved object type"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$3",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- The id of the saved object"
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/serialization/serializer.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils",
"type": "Class",
"tags": [],
"label": "SavedObjectsUtils",
"description": [],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.namespaceIdToString",
"type": "Function",
"tags": [],
"label": "namespaceIdToString",
"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"
],
"signature": [
"(namespace?: string | undefined) => string"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.namespaceIdToString.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"The namespace ID, which must be either a non-empty string or `undefined`."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.namespaceStringToId",
"type": "Function",
"tags": [],
"label": "namespaceStringToId",
"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"
],
"signature": [
"(namespace: string) => string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.namespaceStringToId.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"The namespace string, which must be non-empty."
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.createEmptyFindResponse",
"type": "Function",
"tags": [],
"label": "createEmptyFindResponse",
"description": [
"\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers."
],
"signature": [
"<T, A>({ 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, A>"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1",
"type": "Object",
"tags": [],
"label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.generateId",
"type": "Function",
"tags": [],
"label": "generateId",
"description": [
"\nGenerates a random ID for a saved objects."
],
"signature": [
"() => string"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.isRandomId",
"type": "Function",
"tags": [
"todo"
],
"label": "isRandomId",
"description": [
"\nValidates that a saved object ID has been randomly generated.\n"
],
"signature": [
"(id: string | undefined) => boolean"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.isRandomId.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"The ID of a saved object."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.getConvertedObjectId",
"type": "Function",
"tags": [],
"label": "getConvertedObjectId",
"description": [
"\nUses a single-namespace object's \"legacy ID\" to determine what its new ID will be after it is converted to a multi-namespace type.\n"
],
"signature": [
"(namespace: string | undefined, type: string, id: string) => string"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.getConvertedObjectId.$1",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"The namespace of the saved object before it is converted."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.getConvertedObjectId.$2",
"type": "string",
"tags": [],
"label": "type",
"description": [
"The type of the saved object before it is converted."
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUtils.getConvertedObjectId.$3",
"type": "string",
"tags": [],
"label": "id",
"description": [
"The ID of the saved object before it is converted."
],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/service/lib/utils.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"The ID of the saved object after it is converted."
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry",
"type": "Class",
"tags": [],
"label": "SavedObjectTypeRegistry",
"description": [
"\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.registerType",
"type": "Function",
"tags": [],
"label": "registerType",
"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."
],
"signature": [
"(type: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>) => void"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.registerType.$1",
"type": "Object",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.getType",
"type": "Function",
"tags": [],
"label": "getType",
"description": [
"\nReturn the {@link SavedObjectsType | type} definition for given type name."
],
"signature": [
"(type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.getType.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.getVisibleTypes",
"type": "Function",
"tags": [],
"label": "getVisibleTypes",
"description": [
"\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration."
],
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.getAllTypes",
"type": "Function",
"tags": [],
"label": "getAllTypes",
"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."
],
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes",
"type": "Function",
"tags": [],
"label": "getImportableAndExportableTypes",
"description": [
"\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable."
],
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic",
"type": "Function",
"tags": [],
"label": "isNamespaceAgnostic",
"description": [
"\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered"
],
"signature": [
"(type: string) => boolean"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isSingleNamespace",
"type": "Function",
"tags": [],
"label": "isSingleNamespace",
"description": [
"\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered"
],
"signature": [
"(type: string) => boolean"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isSingleNamespace.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isMultiNamespace",
"type": "Function",
"tags": [],
"label": "isMultiNamespace",
"description": [
"\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered"
],
"signature": [
"(type: string) => boolean"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isMultiNamespace.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isShareable",
"type": "Function",
"tags": [],
"label": "isShareable",
"description": [
"\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered"
],
"signature": [
"(type: string) => boolean"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isShareable.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isHidden",
"type": "Function",
"tags": [],
"label": "isHidden",
"description": [
"\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered."
],
"signature": [
"(type: string) => boolean"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isHidden.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.getIndex",
"type": "Function",
"tags": [],
"label": "getIndex",
"description": [
"\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered."
],
"signature": [
"(type: string) => string | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.getIndex.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable",
"type": "Function",
"tags": [],
"label": "isImportableAndExportable",
"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."
],
"signature": [
"(type: string) => boolean"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "core",
"id": "def-server.ISavedObjectsPointInTimeFinder",
"type": "Interface",
"tags": [],
"label": "ISavedObjectsPointInTimeFinder",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>"
],
"path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.ISavedObjectsPointInTimeFinder.find",
"type": "Function",
"tags": [],
"label": "find",
"description": [
"\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size."
],
"signature": [
"() => AsyncGenerator<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>, any, unknown>"
],
"path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.ISavedObjectsPointInTimeFinder.close",
"type": "Function",
"tags": [],
"label": "close",
"description": [
"\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason."
],
"signature": [
"() => Promise<void>"
],
"path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectExportBaseOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectExportBaseOptions",
"description": [],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectExportBaseOptions.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"The http request initiating the export."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep",
"type": "CompoundType",
"tags": [],
"label": "includeReferencesDeep",
"description": [
"flag to also include all related saved objects in the export stream."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectExportBaseOptions.includeNamespaces",
"type": "CompoundType",
"tags": [],
"label": "includeNamespaces",
"description": [
"\nFlag to also include namespace information in the export stream. By default, namespace information is not included in exported objects.\nThis is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP\nroute for exports."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails",
"type": "CompoundType",
"tags": [],
"label": "excludeExportDetails",
"description": [
"flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectExportBaseOptions.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"optional namespace to override the namespace used by the savedObjectsClient."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationContext",
"type": "Interface",
"tags": [],
"label": "SavedObjectMigrationContext",
"description": [
"\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationContext.log",
"type": "Object",
"tags": [],
"label": "log",
"description": [
"\nlogger instance to be used by the migration handler"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsMigrationLogger",
"text": "SavedObjectsMigrationLogger"
}
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationContext.migrationVersion",
"type": "string",
"tags": [],
"label": "migrationVersion",
"description": [
"\nThe migration version that this migration function is defined for"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion",
"type": "string",
"tags": [],
"label": "convertToMultiNamespaceTypeVersion",
"description": [
"\nThe version in which this object type is being converted to a multi-namespace type"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationContext.isSingleNamespaceType",
"type": "boolean",
"tags": [],
"label": "isSingleNamespaceType",
"description": [
"\nWhether this is a single-namespace type or not"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationMap",
"type": "Interface",
"tags": [],
"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"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationMap.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectReferenceWithContext",
"type": "Interface",
"tags": [],
"label": "SavedObjectReferenceWithContext",
"description": [
"\nA returned input object or one of its references, with additional context.\n"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectReferenceWithContext.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"The type of the referenced object"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectReferenceWithContext.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"The ID of the referenced object"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectReferenceWithContext.spaces",
"type": "Array",
"tags": [],
"label": "spaces",
"description": [
"The space(s) that the referenced object exists in"
],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectReferenceWithContext.inboundReferences",
"type": "Array",
"tags": [],
"label": "inboundReferences",
"description": [
"\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation"
],
"signature": [
"{ type: string; id: string; name: string; }[]"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectReferenceWithContext.isMissing",
"type": "CompoundType",
"tags": [],
"label": "isMissing",
"description": [
"Whether or not this object or reference is missing"
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingAliases",
"type": "Array",
"tags": [],
"label": "spacesWithMatchingAliases",
"description": [
"The space(s) that legacy URL aliases matching this type/id exist in"
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBaseOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBaseOptions",
"description": [
"\n"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBaseOptions.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"Specify the namespace for this operation"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkCreateObject",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.attributes",
"type": "Uncategorized",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"T"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.migrationVersion",
"type": "Object",
"tags": [],
"label": "migrationVersion",
"description": [
"{@inheritDoc SavedObjectsMigrationVersion}"
],
"signature": [
"SavedObjectsMigrationVersion",
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion",
"type": "string",
"tags": [],
"label": "coreMigrationVersion",
"description": [
"\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.originId",
"type": "string",
"tags": [],
"label": "originId",
"description": [
"Optional ID of the original saved object, if this object's `id` was regenerated"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces",
"type": "Array",
"tags": [],
"label": "initialNamespaces",
"description": [
"\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkGetObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkGetObject",
"description": [
"\n"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkGetObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkGetObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkGetObject.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [
"SavedObject fields to include in the response"
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkGetObject.namespaces",
"type": "Array",
"tags": [],
"label": "namespaces",
"description": [
"\nOptional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the\ntop-level options.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResolveObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkResolveObject",
"description": [
"\n"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResolveObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResolveObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResolveResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkResolveResponse",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResolveResponse.resolved_objects",
"type": "Array",
"tags": [],
"label": "resolved_objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkResponse",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResponse.saved_objects",
"type": "Array",
"tags": [],
"label": "saved_objects",
"description": [],
"signature": [
"SavedObject",
"<T>[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkResponse",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkResponse.saved_objects",
"type": "Array",
"tags": [],
"label": "saved_objects",
"description": [],
"signature": [
"SavedObject",
"<T>[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkUpdateObject",
"description": [
"\n"
],
"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"
},
"<T>, \"version\" | \"references\">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
" The type of this Saved Object. Each plugin can define it's own custom Saved Object types."
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateObject.attributes",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [
"{@inheritdoc SavedObjectAttributes}"
],
"signature": [
"{ [P in keyof T]?: T[P] | undefined; }"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateObject.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkUpdateOptions",
"description": [
"\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"signature": [
"boolean | \"wait_for\" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsBulkUpdateResponse",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects",
"type": "Array",
"tags": [],
"label": "saved_objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCheckConflictsObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCheckConflictsObject",
"description": [
"\n"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCheckConflictsObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCheckConflictsObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCheckConflictsResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCheckConflictsResponse",
"description": [
"\n"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCheckConflictsResponse.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"{ id: string; type: string; error: ",
"SavedObjectError",
"; }[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientProviderOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsClientProviderOptions",
"description": [
"\nOptions to control the creation of the Saved Objects Client."
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers",
"type": "Array",
"tags": [],
"label": "excludedWrappers",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes",
"type": "Array",
"tags": [],
"label": "includedHiddenTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientWrapperOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsClientWrapperOptions",
"description": [
"\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance."
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientWrapperOptions.client",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; errors: typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
"; }"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry",
"type": "Object",
"tags": [],
"label": "typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined; getVisibleTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getAllTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getImportableAndExportableTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; 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; }"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientWrapperOptions.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClosePointInTimeResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsClosePointInTimeResponse",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded",
"type": "boolean",
"tags": [],
"label": "succeeded",
"description": [
"\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed."
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed",
"type": "number",
"tags": [],
"label": "num_freed",
"description": [
"\nThe number of search contexts that have been successfully closed."
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCollectMultiNamespaceReferencesObject",
"description": [
"\nAn object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the\n`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option).\n\nNote: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with\nthe `namespaceType: 'multiple'`).\n"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCollectMultiNamespaceReferencesOptions",
"description": [
"\nOptions for collecting references.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions.purpose",
"type": "CompoundType",
"tags": [],
"label": "purpose",
"description": [
"Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences'"
],
"signature": [
"\"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCollectMultiNamespaceReferencesResponse",
"description": [
"\nThe response when object references are collected.\n"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse.objects",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectReferenceWithContext",
"text": "SavedObjectReferenceWithContext"
},
"[]"
],
"path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCreateOptions",
"description": [
"\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"(not recommended) Specify an id for the document"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.overwrite",
"type": "CompoundType",
"tags": [],
"label": "overwrite",
"description": [
"Overwrite existing documents (defaults to false)"
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.migrationVersion",
"type": "Object",
"tags": [],
"label": "migrationVersion",
"description": [
"{@inheritDoc SavedObjectsMigrationVersion}"
],
"signature": [
"SavedObjectsMigrationVersion",
" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion",
"type": "string",
"tags": [],
"label": "coreMigrationVersion",
"description": [
"\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"signature": [
"boolean | \"wait_for\" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.originId",
"type": "string",
"tags": [],
"label": "originId",
"description": [
"Optional ID of the original saved object, if this object's `id` was regenerated"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreateOptions.initialNamespaces",
"type": "Array",
"tags": [],
"label": "initialNamespaces",
"description": [
"\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"type": "Interface",
"tags": [],
"label": "SavedObjectsCreatePointInTimeFinderDependencies",
"description": [],
"path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
"{ find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; }"
],
"path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsDeleteByNamespaceOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsDeleteByNamespaceOptions",
"description": [
"\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"The Elasticsearch supports only boolean flag for this operation"
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsDeleteOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsDeleteOptions",
"description": [
"\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsDeleteOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"signature": [
"boolean | \"wait_for\" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsDeleteOptions.force",
"type": "CompoundType",
"tags": [],
"label": "force",
"description": [
"Force deletion of an object that exists in multiple namespaces"
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportByObjectOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsExportByObjectOptions",
"description": [
"\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportByObjectOptions.objects",
"type": "Array",
"tags": [],
"label": "objects",
"description": [
"optional array of objects to export."
],
"signature": [
"{ id: string; type: string; }[]"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportByTypeOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsExportByTypeOptions",
"description": [
"\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportByTypeOptions.types",
"type": "Array",
"tags": [],
"label": "types",
"description": [
"array of saved object types."
],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportByTypeOptions.hasReference",
"type": "Array",
"tags": [],
"label": "hasReference",
"description": [
"optional array of references to search object for."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference"
},
"[] | undefined"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportByTypeOptions.search",
"type": "string",
"tags": [],
"label": "search",
"description": [
"optional query string to filter exported objects."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportExcludedObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsExportExcludedObject",
"description": [],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportExcludedObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"id of the excluded object"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportExcludedObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"type of the excluded object"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportExcludedObject.reason",
"type": "string",
"tags": [],
"label": "reason",
"description": [
"optional cause of the exclusion"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportResultDetails",
"type": "Interface",
"tags": [],
"label": "SavedObjectsExportResultDetails",
"description": [
"\nStructure of the export result details entry"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportResultDetails.exportedCount",
"type": "number",
"tags": [],
"label": "exportedCount",
"description": [
"number of successfully exported objects"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportResultDetails.missingRefCount",
"type": "number",
"tags": [],
"label": "missingRefCount",
"description": [
"number of missing references"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportResultDetails.missingReferences",
"type": "Array",
"tags": [],
"label": "missingReferences",
"description": [
"missing references details"
],
"signature": [
"{ id: string; type: string; }[]"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportResultDetails.excludedObjectsCount",
"type": "number",
"tags": [],
"label": "excludedObjectsCount",
"description": [
"number of objects that were excluded from the export"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportResultDetails.excludedObjects",
"type": "Array",
"tags": [],
"label": "excludedObjects",
"description": [
"excluded objects details"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportExcludedObject",
"text": "SavedObjectsExportExcludedObject"
},
"[]"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportTransformContext",
"type": "Interface",
"tags": [],
"label": "SavedObjectsExportTransformContext",
"description": [
"\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportTransformContext.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsFindOptions",
"description": [
"\n"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | string[]"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.page",
"type": "number",
"tags": [],
"label": "page",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.perPage",
"type": "number",
"tags": [],
"label": "perPage",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.sortField",
"type": "string",
"tags": [],
"label": "sortField",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.sortOrder",
"type": "CompoundType",
"tags": [],
"label": "sortOrder",
"description": [],
"signature": [
"\"asc\" | \"desc\" | \"_doc\" | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [
"\nAn array of fields to include in the results"
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.search",
"type": "string",
"tags": [],
"label": "search",
"description": [
"Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.searchFields",
"type": "Array",
"tags": [],
"label": "searchFields",
"description": [
"The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information"
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.searchAfter",
"type": "Array",
"tags": [],
"label": "searchAfter",
"description": [
"\nUse the sort values from the previous page to retrieve the next page of results."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.rootSearchFields",
"type": "Array",
"tags": [],
"label": "rootSearchFields",
"description": [
"\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.hasReference",
"type": "CompoundType",
"tags": [],
"label": "hasReference",
"description": [
"\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references."
],
"signature": [
{
"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"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.hasReferenceOperator",
"type": "CompoundType",
"tags": [],
"label": "hasReferenceOperator",
"description": [
"\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`"
],
"signature": [
"\"AND\" | \"OR\" | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.defaultSearchOperator",
"type": "CompoundType",
"tags": [],
"label": "defaultSearchOperator",
"description": [
"\nThe search operator to use with the provided filter. Defaults to `OR`"
],
"signature": [
"\"AND\" | \"OR\" | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.filter",
"type": "Any",
"tags": [],
"label": "filter",
"description": [],
"signature": [
"any"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.aggs",
"type": "Object",
"tags": [
"alpha"
],
"label": "aggs",
"description": [
"\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n"
],
"signature": [
"Record<string, ",
"AggregationsAggregationContainer",
"> | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.namespaces",
"type": "Array",
"tags": [],
"label": "namespaces",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap",
"type": "Object",
"tags": [],
"label": "typeToNamespacesMap",
"description": [
"\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace."
],
"signature": [
"Map<string, string[] | undefined> | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.preference",
"type": "string",
"tags": [],
"label": "preference",
"description": [
"An optional ES preference value to be used for the query"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptions.pit",
"type": "Object",
"tags": [],
"label": "pit",
"description": [
"\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsPitParams",
"text": "SavedObjectsPitParams"
},
" | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptionsReference",
"type": "Interface",
"tags": [],
"label": "SavedObjectsFindOptionsReference",
"description": [],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptionsReference.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindOptionsReference.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsFindResponse",
"description": [
"\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResponse.aggregations",
"type": "Uncategorized",
"tags": [],
"label": "aggregations",
"description": [],
"signature": [
"A | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResponse.saved_objects",
"type": "Array",
"tags": [],
"label": "saved_objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResult",
"text": "SavedObjectsFindResult"
},
"<T>[]"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResponse.total",
"type": "number",
"tags": [],
"label": "total",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResponse.per_page",
"type": "number",
"tags": [],
"label": "per_page",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResponse.page",
"type": "number",
"tags": [],
"label": "page",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResponse.pit_id",
"type": "string",
"tags": [],
"label": "pit_id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResult",
"type": "Interface",
"tags": [],
"label": "SavedObjectsFindResult",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResult",
"text": "SavedObjectsFindResult"
},
"<T> extends ",
"SavedObject",
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResult.score",
"type": "number",
"tags": [],
"label": "score",
"description": [
"\nThe Elasticsearch `_score` of this result."
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFindResult.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
"\nThe Elasticsearch `sort` value of this result.\n"
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportActionRequiredWarning",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportActionRequiredWarning",
"description": [
"\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportActionRequiredWarning.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"action_required\""
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportActionRequiredWarning.message",
"type": "string",
"tags": [],
"label": "message",
"description": [
"The translated message to display to the user."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath",
"type": "string",
"tags": [],
"label": "actionPath",
"description": [
"The path (without the basePath) that the user should be redirect to address this warning."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel",
"type": "string",
"tags": [],
"label": "buttonLabel",
"description": [
"An optional label to use for the link button. If unspecified, a default label will be used."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportAmbiguousConflictError",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportAmbiguousConflictError",
"description": [
"\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportAmbiguousConflictError.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"ambiguous_conflict\""
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations",
"type": "Array",
"tags": [],
"label": "destinations",
"description": [],
"signature": [
"{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportConflictError",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportConflictError",
"description": [
"\nRepresents a failure to import due to a conflict."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportConflictError.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"conflict\""
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportConflictError.destinationId",
"type": "string",
"tags": [],
"label": "destinationId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportFailure",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportFailure",
"description": [
"\nRepresents a failure to import."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportFailure.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportFailure.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportFailure.title",
"type": "string",
"tags": [
"deprecated"
],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": true,
"references": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportFailure.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"{ title?: string | undefined; icon?: string | undefined; }"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportFailure.overwrite",
"type": "CompoundType",
"tags": [],
"label": "overwrite",
"description": [
"\nIf `overwrite` is specified, an attempt was made to overwrite an existing object."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportFailure.error",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"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"
}
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportHookResult",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportHookResult",
"description": [
"\nResult from a {@link SavedObjectsImportHook | import hook}\n"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportHookResult.warnings",
"type": "Array",
"tags": [],
"label": "warnings",
"description": [
"\nAn optional list of warnings to display in the UI when the import succeeds."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportWarning",
"text": "SavedObjectsImportWarning"
},
"[] | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportMissingReferencesError",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportMissingReferencesError",
"description": [
"\nRepresents a failure to import due to missing references."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportMissingReferencesError.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"missing_references\""
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportMissingReferencesError.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"{ type: string; id: string; }[]"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportOptions",
"description": [
"\nOptions to control the import operation."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportOptions.readStream",
"type": "Object",
"tags": [],
"label": "readStream",
"description": [
"The stream of {@link SavedObject | saved objects} to import"
],
"signature": [
"Readable"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportOptions.overwrite",
"type": "boolean",
"tags": [],
"label": "overwrite",
"description": [
"If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportOptions.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"if specified, will import in given namespace, else will import as global object"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportOptions.createNewCopies",
"type": "boolean",
"tags": [],
"label": "createNewCopies",
"description": [
"If true, will create new copies of import objects, each with a random `id` and undefined `originId`."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportResponse",
"description": [
"\nThe response describing the result of an import."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportResponse.success",
"type": "boolean",
"tags": [],
"label": "success",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportResponse.successCount",
"type": "number",
"tags": [],
"label": "successCount",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportResponse.successResults",
"type": "Array",
"tags": [],
"label": "successResults",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportSuccess",
"text": "SavedObjectsImportSuccess"
},
"[] | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportResponse.warnings",
"type": "Array",
"tags": [],
"label": "warnings",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportWarning",
"text": "SavedObjectsImportWarning"
},
"[]"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportResponse.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportFailure",
"text": "SavedObjectsImportFailure"
},
"[] | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportRetry",
"description": [
"\nDescribes a retry operation for importing a saved object."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry.overwrite",
"type": "boolean",
"tags": [],
"label": "overwrite",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry.destinationId",
"type": "string",
"tags": [],
"label": "destinationId",
"description": [
"\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry.replaceReferences",
"type": "Array",
"tags": [],
"label": "replaceReferences",
"description": [],
"signature": [
"{ type: string; from: string; to: string; }[]"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry.createNewCopy",
"type": "CompoundType",
"tags": [],
"label": "createNewCopy",
"description": [
"\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences",
"type": "CompoundType",
"tags": [],
"label": "ignoreMissingReferences",
"description": [
"\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSimpleWarning",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportSimpleWarning",
"description": [
"\nA simple informative warning that will be displayed to the user.\n"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSimpleWarning.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"simple\""
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSimpleWarning.message",
"type": "string",
"tags": [],
"label": "message",
"description": [
"The translated message to display to the user"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSuccess",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportSuccess",
"description": [
"\nRepresents a successful import."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSuccess.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSuccess.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSuccess.destinationId",
"type": "string",
"tags": [],
"label": "destinationId",
"description": [
"\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSuccess.createNewCopy",
"type": "CompoundType",
"tags": [
"deprecated"
],
"label": "createNewCopy",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": true,
"references": [
{
"plugin": "spaces",
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx"
},
{
"plugin": "savedObjectsManagement",
"path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts"
}
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSuccess.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"{ title?: string | undefined; icon?: string | undefined; }"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportSuccess.overwrite",
"type": "CompoundType",
"tags": [],
"label": "overwrite",
"description": [
"\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportUnknownError",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportUnknownError",
"description": [
"\nRepresents a failure to import due to an unknown reason."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportUnknownError.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"unknown\""
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportUnknownError.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportUnknownError.statusCode",
"type": "number",
"tags": [],
"label": "statusCode",
"description": [],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportUnsupportedTypeError",
"type": "Interface",
"tags": [],
"label": "SavedObjectsImportUnsupportedTypeError",
"description": [
"\nRepresents a failure to import due to having an unsupported saved object type."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportUnsupportedTypeError.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"unsupported_type\""
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterField",
"type": "Interface",
"tags": [],
"label": "SavedObjectsIncrementCounterField",
"description": [],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterField.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [
"The field name to increment the counter by."
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterField.incrementBy",
"type": "number",
"tags": [],
"label": "incrementBy",
"description": [
"The number to increment the field by (defaults to 1)."
],
"signature": [
"number | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsIncrementCounterOptions",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsIncrementCounterOptions",
"text": "SavedObjectsIncrementCounterOptions"
},
"<Attributes> extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterOptions.initialize",
"type": "CompoundType",
"tags": [],
"label": "initialize",
"description": [
"\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion",
"type": "Object",
"tags": [],
"label": "migrationVersion",
"description": [
"{@link SavedObjectsMigrationVersion}"
],
"signature": [
"SavedObjectsMigrationVersion",
" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}"
],
"signature": [
"boolean | \"wait_for\" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes",
"type": "Uncategorized",
"tags": [],
"label": "upsertAttributes",
"description": [
"\nAttributes to use when upserting the document if it doesn't exist."
],
"signature": [
"Attributes | undefined"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMappingProperties",
"type": "Interface",
"tags": [],
"label": "SavedObjectsMappingProperties",
"description": [
"\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n"
],
"path": "src/core/server/saved_objects/mappings/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMappingProperties.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "src/core/server/saved_objects/mappings/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger",
"type": "Interface",
"tags": [],
"label": "SavedObjectsMigrationLogger",
"description": [],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.debug",
"type": "Function",
"tags": [],
"label": "debug",
"description": [],
"signature": [
"(msg: string) => void"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.debug.$1",
"type": "string",
"tags": [],
"label": "msg",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.info",
"type": "Function",
"tags": [],
"label": "info",
"description": [],
"signature": [
"(msg: string) => void"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.info.$1",
"type": "string",
"tags": [],
"label": "msg",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.warning",
"type": "Function",
"tags": [
"deprecated"
],
"label": "warning",
"description": [],
"signature": [
"(msg: string) => void"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": true,
"references": [
{
"plugin": "lens",
"path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts"
},
{
"plugin": "lens",
"path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts"
},
{
"plugin": "dashboard",
"path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts"
}
],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.warning.$1",
"type": "string",
"tags": [],
"label": "msg",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.warn",
"type": "Function",
"tags": [],
"label": "warn",
"description": [],
"signature": [
"(msg: string) => void"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.warn.$1",
"type": "string",
"tags": [],
"label": "msg",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.error",
"type": "Function",
"tags": [],
"label": "error",
"description": [],
"signature": [
"<Meta extends ",
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.LogMeta",
"text": "LogMeta"
},
" = ",
{
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.LogMeta",
"text": "LogMeta"
},
">(msg: string, meta: Meta) => void"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.error.$1",
"type": "string",
"tags": [],
"label": "msg",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsMigrationLogger.error.$2",
"type": "Uncategorized",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"Meta"
],
"path": "src/core/server/saved_objects/migrations/core/migration_logger.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsOpenPointInTimeOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsOpenPointInTimeOptions",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive",
"type": "string",
"tags": [],
"label": "keepAlive",
"description": [
"\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsOpenPointInTimeOptions.preference",
"type": "string",
"tags": [],
"label": "preference",
"description": [
"\nAn optional ES preference value to be used for the query."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsOpenPointInTimeOptions.namespaces",
"type": "Array",
"tags": [],
"label": "namespaces",
"description": [
"\nAn optional list of namespaces to be used when opening the PIT.\n\nWhen the spaces plugin is enabled:\n - this will default to the user's current space (as determined by the URL)\n - if specified, the user's current space will be ignored\n - `['*']` will search across all available spaces"
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsOpenPointInTimeResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsOpenPointInTimeResponse",
"description": [],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsOpenPointInTimeResponse.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nPIT ID returned from ES."
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsPitParams",
"type": "Interface",
"tags": [],
"label": "SavedObjectsPitParams",
"description": [],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsPitParams.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsPitParams.keepAlive",
"type": "string",
"tags": [],
"label": "keepAlive",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRawDoc",
"type": "Interface",
"tags": [],
"label": "SavedObjectsRawDoc",
"description": [
"\nA raw document as represented directly in the saved object index.\n"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRawDoc._id",
"type": "string",
"tags": [],
"label": "_id",
"description": [],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRawDoc._source",
"type": "Object",
"tags": [],
"label": "_source",
"description": [],
"signature": [
"SavedObjectsRawDocSource"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRawDoc._seq_no",
"type": "number",
"tags": [],
"label": "_seq_no",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRawDoc._primary_term",
"type": "number",
"tags": [],
"label": "_primary_term",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRawDocParseOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsRawDocParseOptions",
"description": [
"\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment",
"type": "CompoundType",
"tags": [],
"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`."
],
"signature": [
"\"strict\" | \"lax\" | undefined"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRemoveReferencesToOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsRemoveReferencesToOptions",
"description": [
"\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation. Defaults to `true`"
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRemoveReferencesToResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsRemoveReferencesToResponse",
"description": [
"\n"
],
"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"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRemoveReferencesToResponse.updated",
"type": "number",
"tags": [],
"label": "updated",
"description": [
"The number of objects that have been updated by this operation"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepositoryFactory",
"type": "Interface",
"tags": [],
"label": "SavedObjectsRepositoryFactory",
"description": [
"\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository",
"type": "Function",
"tags": [],
"label": "createScopedRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n"
],
"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"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$1",
"type": "Object",
"tags": [],
"label": "req",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$2",
"type": "Array",
"tags": [],
"label": "includedHiddenTypes",
"description": [
"- A list of additional hidden types the repository should have access to."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository",
"type": "Function",
"tags": [],
"label": "createInternalRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n"
],
"signature": [
"(includedHiddenTypes?: string[] | undefined) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository.$1",
"type": "Array",
"tags": [],
"label": "includedHiddenTypes",
"description": [
"- A list of additional hidden types the repository should have access to."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveImportErrorsOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsResolveImportErrorsOptions",
"description": [
"\nOptions to control the \"resolve import\" operation."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream",
"type": "Object",
"tags": [],
"label": "readStream",
"description": [
"The stream of {@link SavedObject | saved objects} to resolve errors from"
],
"signature": [
"Readable"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveImportErrorsOptions.retries",
"type": "Array",
"tags": [],
"label": "retries",
"description": [
"saved object import references to retry"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportRetry",
"text": "SavedObjectsImportRetry"
},
"[]"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [
"if specified, will import in given namespace"
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies",
"type": "boolean",
"tags": [],
"label": "createNewCopies",
"description": [
"If true, will create new copies of import objects, each with a random `id` and undefined `originId`."
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsResolveResponse",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveResponse.saved_object",
"type": "Object",
"tags": [],
"label": "saved_object",
"description": [
"\nThe saved object that was found."
],
"signature": [
"SavedObject",
"<T>"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveResponse.outcome",
"type": "CompoundType",
"tags": [],
"label": "outcome",
"description": [
"\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID."
],
"signature": [
"\"conflict\" | \"exactMatch\" | \"aliasMatch\""
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveResponse.alias_target_id",
"type": "string",
"tags": [],
"label": "alias_target_id",
"description": [
"\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup",
"type": "Interface",
"tags": [],
"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"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider",
"type": "Function",
"tags": [],
"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."
],
"signature": [
"(clientFactoryProvider: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientFactoryProvider",
"text": "SavedObjectsClientFactoryProvider"
},
") => void"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider.$1",
"type": "Function",
"tags": [],
"label": "clientFactoryProvider",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientFactoryProvider",
"text": "SavedObjectsClientFactoryProvider"
}
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.addClientWrapper",
"type": "Function",
"tags": [],
"label": "addClientWrapper",
"description": [
"\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority."
],
"signature": [
"(priority: number, id: string, factory: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientWrapperFactory",
"text": "SavedObjectsClientWrapperFactory"
},
") => void"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$1",
"type": "number",
"tags": [],
"label": "priority",
"description": [],
"signature": [
"number"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$2",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$3",
"type": "Function",
"tags": [],
"label": "factory",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientWrapperFactory",
"text": "SavedObjectsClientWrapperFactory"
}
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.registerType",
"type": "Function",
"tags": [],
"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"
],
"signature": [
"<Attributes = any>(type: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<Attributes>) => void"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceSetup.registerType.$1",
"type": "Object",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<Attributes>"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart",
"type": "Interface",
"tags": [],
"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"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.getScopedClient",
"type": "Function",
"tags": [],
"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}."
],
"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"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.getScopedClient.$1",
"type": "Object",
"tags": [],
"label": "req",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.getScopedClient.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientProviderOptions",
"text": "SavedObjectsClientProviderOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createScopedRepository",
"type": "Function",
"tags": [],
"label": "createScopedRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n"
],
"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"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createScopedRepository.$1",
"type": "Object",
"tags": [],
"label": "req",
"description": [
"- The request to create the scoped repository from."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createScopedRepository.$2",
"type": "Array",
"tags": [],
"label": "includedHiddenTypes",
"description": [
"- A list of additional hidden types the repository should have access to."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createInternalRepository",
"type": "Function",
"tags": [],
"label": "createInternalRepository",
"description": [
"\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n"
],
"signature": [
"(includedHiddenTypes?: string[] | undefined) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepository",
"text": "SavedObjectsRepository"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createInternalRepository.$1",
"type": "Array",
"tags": [],
"label": "includedHiddenTypes",
"description": [
"- A list of additional hidden types the repository should have access to."
],
"signature": [
"string[] | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createSerializer",
"type": "Function",
"tags": [],
"label": "createSerializer",
"description": [
"\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types."
],
"signature": [
"() => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsSerializer",
"text": "SavedObjectsSerializer"
}
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createExporter",
"type": "Function",
"tags": [],
"label": "createExporter",
"description": [
"\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client."
],
"signature": [
"(client: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExporter",
"text": "SavedObjectsExporter"
},
", \"exportByTypes\" | \"exportByObjects\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createExporter.$1",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createImporter",
"type": "Function",
"tags": [],
"label": "createImporter",
"description": [
"\nCreates an {@link ISavedObjectsImporter | importer} bound to given client."
],
"signature": [
"(client: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImporter",
"text": "SavedObjectsImporter"
},
", \"import\" | \"resolveImportErrors\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.createImporter.$1",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClient",
"text": "SavedObjectsClient"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsServiceStart.getTypeRegistry",
"type": "Function",
"tags": [],
"label": "getTypeRegistry",
"description": [
"\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}"
],
"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\">"
],
"path": "src/core/server/saved_objects/saved_objects_service.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectStatusMeta",
"type": "Interface",
"tags": [],
"label": "SavedObjectStatusMeta",
"description": [
"\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectStatusMeta.migratedIndices",
"type": "Object",
"tags": [],
"label": "migratedIndices",
"description": [],
"signature": [
"{ [status: string]: number; skipped: number; migrated: number; }"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType",
"type": "Interface",
"tags": [],
"label": "SavedObjectsType",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<Attributes>"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nThe name of the type, which is also used as the internal id."
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.hidden",
"type": "boolean",
"tags": [],
"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}."
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.namespaceType",
"type": "CompoundType",
"tags": [],
"label": "namespaceType",
"description": [
"\nThe {@link SavedObjectsNamespaceType | namespace type} for the type."
],
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.indexPattern",
"type": "string",
"tags": [],
"label": "indexPattern",
"description": [
"\nIf defined, the type instances will be stored in the given index instead of the default one."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.convertToAliasScript",
"type": "string",
"tags": [],
"label": "convertToAliasScript",
"description": [
"\nIf defined, will be used to convert the type to an alias."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.excludeOnUpgrade",
"type": "Function",
"tags": [],
"label": "excludeOnUpgrade",
"description": [
"\nIf defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted.\nSee {@link SavedObjectTypeExcludeFromUpgradeFilterHook} for more details."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectTypeExcludeFromUpgradeFilterHook",
"text": "SavedObjectTypeExcludeFromUpgradeFilterHook"
},
" | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.mappings",
"type": "Object",
"tags": [],
"label": "mappings",
"description": [
"\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsTypeMappingDefinition",
"text": "SavedObjectsTypeMappingDefinition"
}
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.migrations",
"type": "CompoundType",
"tags": [],
"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."
],
"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"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion",
"type": "string",
"tags": [],
"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."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsType.management",
"type": "Object",
"tags": [],
"label": "management",
"description": [
"\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type."
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsTypeManagementDefinition",
"text": "SavedObjectsTypeManagementDefinition"
},
"<Attributes> | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition",
"type": "Interface",
"tags": [],
"label": "SavedObjectsTypeManagementDefinition",
"description": [
"\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsTypeManagementDefinition",
"text": "SavedObjectsTypeManagementDefinition"
},
"<Attributes>"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable",
"type": "CompoundType",
"tags": [],
"label": "importableAndExportable",
"description": [
"\nIs the type importable or exportable. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [
"\nWhen specified, will be used instead of the type's name in SO management section's labels."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.visibleInManagement",
"type": "CompoundType",
"tags": [],
"label": "visibleInManagement",
"description": [
"\nWhen set to false, the type will not be listed or searchable in the SO management section.\nMain usage of setting this property to false for a type is when objects from the type should\nbe included in the export via references or export hooks, but should not directly appear in the SOM.\nDefaults to `true`.\n"
],
"signature": [
"boolean | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField",
"type": "string",
"tags": [],
"label": "defaultSearchField",
"description": [
"\nThe default search field to use for this type. Defaults to `id`."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [
"\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.getTitle",
"type": "Function",
"tags": [],
"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."
],
"signature": [
"((savedObject: ",
"SavedObject",
"<Attributes>) => string) | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.getTitle.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
"SavedObject",
"<Attributes>"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl",
"type": "Function",
"tags": [],
"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."
],
"signature": [
"((savedObject: ",
"SavedObject",
"<Attributes>) => string) | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
"SavedObject",
"<Attributes>"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl",
"type": "Function",
"tags": [],
"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"
],
"signature": [
"((savedObject: ",
"SavedObject",
"<Attributes>) => { path: string; uiCapabilitiesPath: string; }) | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl.$1",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
"SavedObject",
"<Attributes>"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [
"an object containing a `path` and `uiCapabilitiesPath` properties. the `path` is the path to\nthe object page, relative to the base path. `uiCapabilitiesPath` is the path to check in the\n{@link Capabilities | uiCapabilities} to check if the user has permission to access the object."
]
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.onExport",
"type": "Function",
"tags": [],
"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\nWhen implementing both `isExportable` and `onExport`, it is mandatory that\n`isExportable` returns the same value for an object before and after going\nthough the export transform.\nE.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)`\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportTransform",
"text": "SavedObjectsExportTransform"
},
"<Attributes> | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.onImport",
"type": "Function",
"tags": [],
"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"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportHook",
"text": "SavedObjectsImportHook"
},
"<Attributes> | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeManagementDefinition.isExportable",
"type": "Function",
"tags": [],
"label": "isExportable",
"description": [
"\nOptional hook to specify whether an object should be exportable.\n\nIf specified, `isExportable` will be called during export for each\nof this type's objects in the export, and the ones not matching the\npredicate will be excluded from the export.\n\nWhen implementing both `isExportable` and `onExport`, it is mandatory that\n`isExportable` returns the same value for an object before and after going\nthough the export transform.\nE.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)`\n"
],
"signature": [
"SavedObjectsExportablePredicate",
"<Attributes> | undefined"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeMappingDefinition",
"type": "Interface",
"tags": [],
"label": "SavedObjectsTypeMappingDefinition",
"description": [
"\nDescribe a saved object type mapping.\n"
],
"path": "src/core/server/saved_objects/mappings/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeMappingDefinition.dynamic",
"type": "CompoundType",
"tags": [],
"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."
],
"signature": [
"false | \"strict\" | undefined"
],
"path": "src/core/server/saved_objects/mappings/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsTypeMappingDefinition.properties",
"type": "Object",
"tags": [],
"label": "properties",
"description": [
"The underlying properties of the type mapping"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsMappingProperties",
"text": "SavedObjectsMappingProperties"
}
],
"path": "src/core/server/saved_objects/mappings/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsUpdateObjectsSpacesObject",
"description": [
"\nAn object that should have its spaces updated.\n"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"The type of the object to update"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"The ID of the object to update"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsUpdateObjectsSpacesOptions",
"description": [
"\nOptions for the update operation.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"signature": [
"boolean | \"wait_for\" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsUpdateObjectsSpacesResponse",
"description": [
"\nThe response when objects' spaces are updated.\n"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponse.objects",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject",
"text": "SavedObjectsUpdateObjectsSpacesResponseObject"
},
"[]"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject",
"type": "Interface",
"tags": [],
"label": "SavedObjectsUpdateObjectsSpacesResponseObject",
"description": [
"\nDetails about a specific object's update result.\n"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"The type of the referenced object"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"The ID of the referenced object"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces",
"type": "Array",
"tags": [],
"label": "spaces",
"description": [
"The space(s) that the referenced object exists in"
],
"signature": [
"string[]"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error",
"type": "Object",
"tags": [],
"label": "error",
"description": [
"Included if there was an error updating this object's spaces"
],
"signature": [
"SavedObjectError",
" | undefined"
],
"path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateOptions",
"type": "Interface",
"tags": [],
"label": "SavedObjectsUpdateOptions",
"description": [
"\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<Attributes> extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateOptions.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."
],
"signature": [
"string | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateOptions.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [
"{@inheritdoc SavedObjectReference}"
],
"signature": [
"SavedObjectReference",
"[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateOptions.refresh",
"type": "CompoundType",
"tags": [],
"label": "refresh",
"description": [
"The Elasticsearch Refresh setting for this operation"
],
"signature": [
"boolean | \"wait_for\" | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateOptions.upsert",
"type": "Uncategorized",
"tags": [],
"label": "upsert",
"description": [
"If specified, will be used to perform an upsert if the document doesn't exist"
],
"signature": [
"Attributes | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateResponse",
"type": "Interface",
"tags": [],
"label": "SavedObjectsUpdateResponse",
"description": [
"\n"
],
"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\">"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateResponse.attributes",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"{ [P in keyof T]?: T[P] | undefined; }"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsUpdateResponse.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[] | undefined"
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "core",
"id": "def-server.ISavedObjectsExporter",
"type": "Type",
"tags": [],
"label": "ISavedObjectsExporter",
"description": [],
"signature": [
"{ exportByTypes: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByTypeOptions",
"text": "SavedObjectsExportByTypeOptions"
},
") => Promise<",
"Readable",
">; exportByObjects: (options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportByObjectOptions",
"text": "SavedObjectsExportByObjectOptions"
},
") => Promise<",
"Readable",
">; }"
],
"path": "src/core/server/saved_objects/export/saved_objects_exporter.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.ISavedObjectsImporter",
"type": "Type",
"tags": [],
"label": "ISavedObjectsImporter",
"description": [],
"signature": [
"{ import: ({ 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"
},
">; resolveImportErrors: ({ 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"
},
">; }"
],
"path": "src/core/server/saved_objects/import/saved_objects_importer.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.ISavedObjectsRepository",
"type": "Type",
"tags": [],
"label": "ISavedObjectsRepository",
"description": [
"\nSee {@link SavedObjectsRepository}\n"
],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
") => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; deleteByNamespace: (namespace: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteByNamespaceOptions",
"text": "SavedObjectsDeleteByNamespaceOptions"
},
") => Promise<any>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; incrementCounter: <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"
},
"<T> | undefined) => Promise<",
"SavedObject",
"<T>>; openPointInTimeForType: (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"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; }"
],
"path": "src/core/server/saved_objects/service/lib/repository.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.ISavedObjectTypeRegistry",
"type": "Type",
"tags": [],
"label": "ISavedObjectTypeRegistry",
"description": [
"\nSee {@link SavedObjectTypeRegistry} for documentation.\n"
],
"signature": [
"{ getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined; getVisibleTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getAllTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getImportableAndExportableTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; 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; }"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.MutatingOperationRefreshSetting",
"type": "Type",
"tags": [],
"label": "MutatingOperationRefreshSetting",
"description": [
"\nElasticsearch Refresh setting for mutating operation"
],
"signature": [
"boolean | \"wait_for\""
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationFn",
"type": "Type",
"tags": [],
"label": "SavedObjectMigrationFn",
"description": [
"\nA migration function for a {@link SavedObjectsType | saved object type}\nused to migrate it to a given version\n"
],
"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>"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationFn.$1",
"type": "CompoundType",
"tags": [],
"label": "doc",
"description": [],
"signature": [
"SavedObjectDoc<InputAttributes> & Partial<Referencable>"
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectMigrationFn.$2",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectMigrationContext",
"text": "SavedObjectMigrationContext"
}
],
"path": "src/core/server/saved_objects/migrations/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectSanitizedDoc",
"type": "Type",
"tags": [],
"label": "SavedObjectSanitizedDoc",
"description": [
"\nDescribes Saved Object documents that have passed through the migration\nframework and are guaranteed to have a `references` root property.\n"
],
"signature": [
"SavedObjectDoc<T> & Referencable"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientContract",
"type": "Type",
"tags": [],
"label": "SavedObjectsClientContract",
"description": [
"\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistence and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n"
],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; errors: typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
"; }"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientFactory",
"type": "Type",
"tags": [],
"label": "SavedObjectsClientFactory",
"description": [
"\nDescribes the factory used to create instances of the Saved Objects Client."
],
"signature": [
"({ request, includedHiddenTypes, }: { 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"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientFactory.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>; includedHiddenTypes?: string[] | undefined; }"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientFactoryProvider",
"type": "Type",
"tags": [],
"label": "SavedObjectsClientFactoryProvider",
"description": [
"\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}."
],
"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"
}
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientFactoryProvider.$1",
"type": "Object",
"tags": [],
"label": "repositoryFactory",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRepositoryFactory",
"text": "SavedObjectsRepositoryFactory"
}
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientWrapperFactory",
"type": "Type",
"tags": [],
"label": "SavedObjectsClientWrapperFactory",
"description": [
"\nDescribes the factory used to create instances of Saved Objects Client Wrappers."
],
"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"
},
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClientWrapperFactory.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientWrapperOptions",
"text": "SavedObjectsClientWrapperOptions"
}
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsClosePointInTimeOptions",
"type": "Type",
"tags": [],
"label": "SavedObjectsClosePointInTimeOptions",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
}
],
"path": "src/core/server/saved_objects/service/saved_objects_client.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
"type": "Type",
"tags": [],
"label": "SavedObjectsCreatePointInTimeFinderOptions",
"description": [],
"signature": [
"{ type: string | string[]; filter?: any; aggs?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | \"_doc\" | undefined; search?: string | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference"
},
"[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map<string, string[] | undefined> | undefined; preference?: string | undefined; }"
],
"path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportTransform",
"type": "Type",
"tags": [],
"label": "SavedObjectsExportTransform",
"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"
],
"signature": [
"(context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportTransformContext",
"text": "SavedObjectsExportTransformContext"
},
", objects: ",
"SavedObject",
"<T>[]) => ",
"SavedObject",
"<unknown>[] | Promise<",
"SavedObject",
"<unknown>[]>"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportTransform.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsExportTransformContext",
"text": "SavedObjectsExportTransformContext"
}
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsExportTransform.$2",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
"SavedObject",
"<T>[]"
],
"path": "src/core/server/saved_objects/export/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsFieldMapping",
"type": "Type",
"tags": [],
"label": "SavedObjectsFieldMapping",
"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"
],
"signature": [
"(",
"MappingFlattenedProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingJoinProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingPercolatorProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingRankFeatureProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingRankFeaturesProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingConstantKeywordProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingFieldAliasProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingHistogramProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingObjectProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingNestedProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingSearchAsYouTypeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingTextProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingBinaryProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingBooleanProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingDateProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingDateNanosProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingKeywordProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingNumberProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingLongRangeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingIpRangeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingIntegerRangeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingFloatRangeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingDoubleRangeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingDateRangeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingGeoPointProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingGeoShapeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingCompletionProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingGenericProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingIpProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingMurmur3HashProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingShapeProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingTokenCountProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingVersionProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingWildcardProperty",
" & { dynamic?: false | \"strict\" | undefined; }) | (",
"MappingPointProperty",
" & { dynamic?: false | \"strict\" | undefined; })"
],
"path": "src/core/server/saved_objects/mappings/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportHook",
"type": "Type",
"tags": [],
"label": "SavedObjectsImportHook",
"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"
],
"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"
},
">"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportHook.$1",
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"signature": [
"SavedObject",
"<T>[]"
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsImportWarning",
"type": "Type",
"tags": [],
"label": "SavedObjectsImportWarning",
"description": [
"\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportSimpleWarning",
"text": "SavedObjectsImportSimpleWarning"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportActionRequiredWarning",
"text": "SavedObjectsImportActionRequiredWarning"
}
],
"path": "src/core/server/saved_objects/import/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsNamespaceType",
"type": "Type",
"tags": [],
"label": "SavedObjectsNamespaceType",
"description": [
"\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n"
],
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeExcludeFromUpgradeFilterHook",
"type": "Type",
"tags": [
"alpha"
],
"label": "SavedObjectTypeExcludeFromUpgradeFilterHook",
"description": [
"\nIf defined, allows a type to run a search query and return a query filter that may match any documents which may\nbe excluded from the next migration upgrade process. Useful for cleaning up large numbers of old documents which\nare no longer needed and may slow the migration process.\n\nIf this hook fails, the migration will proceed without these documents having been filtered out, so this\nshould not be used as a guarantee that these documents have been deleted.\n"
],
"signature": [
"(toolkit: { readonlyEsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", \"search\">; }) => ",
"QueryDslQueryContainer",
" | Promise<",
"QueryDslQueryContainer",
">"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectTypeExcludeFromUpgradeFilterHook.$1",
"type": "Object",
"tags": [],
"label": "toolkit",
"description": [],
"signature": [
"{ readonlyEsClient: Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", \"search\">; }"
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectUnsanitizedDoc",
"type": "Type",
"tags": [],
"label": "SavedObjectUnsanitizedDoc",
"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"
],
"signature": [
"SavedObjectDoc<T> & Partial<Referencable>"
],
"path": "src/core/server/saved_objects/serialization/types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink