Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 2.05 KB

kibana-plugin-public.savedobject.md

File metadata and controls

26 lines (18 loc) · 2.05 KB

Home > kibana-plugin-public > SavedObject

SavedObject interface

Signature:

export interface SavedObject<T extends SavedObjectAttributes = any> 

Properties

Property Type Description
attributes T The data for a Saved Object is stored as an object in the attributes property.
error {
message: string;
statusCode: number;
}
id string The ID of this Saved Object, guaranteed to be unique for all objects of the same type
migrationVersion SavedObjectsMigrationVersion Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator 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.
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 Timestamp of the last time this document had been updated.
version string An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control.