Home > kibana-plugin-core-server > SavedObjectsServiceStart
Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects.
Signature:
export interface SavedObjectsServiceStart | Property | Type | Description |
|---|---|---|
| createExporter | (client: SavedObjectsClientContract) => ISavedObjectsExporter |
Creates an exporter bound to given client. |
| createImporter | (client: SavedObjectsClientContract) => ISavedObjectsImporter |
Creates an importer bound to given client. |
| createInternalRepository | (includedHiddenTypes?: string[]) => ISavedObjectsRepository |
Creates a Saved Objects repository that uses the internal Kibana user for authenticating with Elasticsearch. |
| createScopedRepository | (req: KibanaRequest, includedHiddenTypes?: string[]) => ISavedObjectsRepository |
Creates a Saved Objects repository that uses the credentials from the passed in request to authenticate with Elasticsearch. |
| createSerializer | () => SavedObjectsSerializer |
Creates a serializer that is aware of all registered types. |
| getScopedClient | (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract |
Creates a Saved Objects client that uses the credentials from the passed in request to authenticate with Elasticsearch. If other plugins have registered Saved Objects client wrappers, these will be applied to extend the functionality of the client.A client that is already scoped to the incoming request is also exposed from the route handler context see RequestHandlerContext. |
| getTypeRegistry | () => ISavedObjectTypeRegistry |
Returns the registry containing all registered saved object types |