Opensearch dashboards.savedobjectsservicestart

Home > opensearch-dashboards > SavedObjectsServiceStart

SavedObjectsServiceStart interface

Saved Objects is OpenSearchDashboards's data persisentence mechanism allowing plugins to use OpenSearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects.

Signature:

export interface SavedObjectsServiceStart 

Properties

Property	Type	Description
createInternalRepository	(includedHiddenTypes?: string[]) => ISavedObjectsRepository	Creates a Saved Objects repository that uses the internal OpenSearch Dashboards user for authenticating with OpenSearch.
createScopedRepository	(req: OpenSearchDashboardsRequest, includedHiddenTypes?: string[]) => ISavedObjectsRepository	Creates a Saved Objects repository that uses the credentials from the passed in request to authenticate with OpenSearch.
createSerializer	() => SavedObjectsSerializer	Creates a serializer that is aware of all registered types.
getScopedClient	(req: OpenSearchDashboardsRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract	Creates a Saved Objects client that uses the credentials from the passed in request to authenticate with OpenSearch. 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