Opensearch dashboards.savedobject

Home > opensearch-dashboards > SavedObject

SavedObject interface

Signature:

export interface SavedObject<T = unknown> 

Properties

Property	Type	Description
attributes	T	The data for a Saved Object is stored as an object in the attributes property.
error?	SavedObjectError	(Optional)
id	string	The ID of this Saved Object, guaranteed to be unique for all objects of the same type
migrationVersion?	SavedObjectsMigrationVersion	(Optional) Information about the migrations that have been applied to this SavedObject. When OpenSearch Dashboards starts up, OpenSearchDashboardsMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value.
namespaces?	string[]	(Optional) Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types.
originId?	string	(Optional) The ID of the saved object this originated from. This is set if this object's id was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space.
references	SavedObjectReference[]	A reference to another saved object.
type	string	The type of Saved Object. Each plugin can define it's own custom Saved Object types.
updated_at?	string	(Optional) Timestamp of the last time this document had been updated.
version?	string	(Optional) An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control.