Opensearch dashboards.savedobjectsserializer

Home > opensearch-dashboards > SavedObjectsSerializer

SavedObjectsSerializer class

A serializer that can be used to manually convert raw or sanitized documents to the other kind.

Signature:

export declare class SavedObjectsSerializer 

Remarks

Serializer instances should only be created and accessed by calling SavedObjectsServiceStart.createSerializer

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SavedObjectsSerializer class.

Methods

Method	Modifiers	Description
generateRawId(namespace, type, id)		Given a saved object type and id, generates the compound id that is stored in the raw document.
isRawSavedObject(rawDoc)		Determines whether or not the raw document can be converted to a saved object.
rawToSavedObject(doc)		Converts a document from the format that is stored in opensearch to the saved object client format.
savedObjectToRaw(savedObj)		Converts a document from the saved object client format to the format that is stored in opensearch.