Opensearch dashboards.savedobjectsclient
Home > opensearch-dashboards > SavedObjectsClient
SavedObjectsClient class
Signature:
export declare class SavedObjectsClient
Remarks
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SavedObjectsClient class.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| errors | typeof SavedObjectsErrorHelpers | ||
| errors | static |
typeof SavedObjectsErrorHelpers |
Methods
| Method | Modifiers | Description |
|---|---|---|
| addToNamespaces(type, id, namespaces, options) | Adds namespaces to a SavedObject | |
| bulkCreate(objects, options) | Persists multiple documents batched together as a single request | |
| bulkGet(objects, options) | Returns an array of objects by id | |
| bulkUpdate(objects, options) | Bulk Updates multiple SavedObject at once | |
| checkConflicts(objects, options) | Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. | |
| create(type, attributes, options) | Persists a SavedObject | |
| delete(type, id, options) | Deletes a SavedObject | |
| deleteFromNamespaces(type, id, namespaces, options) | Removes namespaces from a SavedObject | |
| find(options) | Find all SavedObjects matching the search query | |
| get(type, id, options) | Retrieves a single object | |
| update(type, id, attributes, options) | Updates an SavedObject |