Opensearch dashboards.savedobjectstype
Home > opensearch-dashboards > SavedObjectsType
SavedObjectsType interface
Signature:
export interface SavedObjectsType
Remarks
This is only internal for now, and will only be public when we expose the registerType API
Properties
Property | Type | Description |
---|---|---|
convertToAliasScript? | string | (Optional) If defined, will be used to convert the type to an alias. |
hidden | boolean | Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an extraType when creating the repository.See createInternalRepository. |
indexPattern? | string | (Optional) If defined, the type instances will be stored in the given index instead of the default one. |
management? | SavedObjectsTypeManagementDefinition | (Optional) An optional saved objects management section definition for the type. |
mappings | SavedObjectsTypeMappingDefinition | The mapping definition for the type. |
migrations? | SavedObjectMigrationMap | (Optional) An optional map of migrations to be used to migrate the type. |
name | string | The name of the type, which is also used as the internal id. |
namespaceType | SavedObjectsNamespaceType | The namespace type for the type. |