github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Core] Public saved objects client (#39891) (#42760)

Browse source 
* Move SavedObjectClient files to core/public

* Initial SavedObjectsService in public Core

* Public SavedObjectsClient tests

* Import SimpleSavedObject from src/core/public

* Use types from source files for kibana.d.ts

* Add html raw loader to x-pack/jest

* Cleanup

* Drop case utilities and improve test coverage

* Update types and documentation

* Fix build breaking when importing directly from /server in /public

* Ensure that all option paramaters are picked and renamed

* Fix option mapping and introduce stronger types

* Eslint: allow imports from src/core/*/types

* Add compatibility layer for kfetch vs http.fetch error responses

* Improve documentation

* Expose SavedObjectsMigrationLogger

* Documentation and type tweaks

* Revert type changes from 73e601f and update api docs

* Refactor request into savedObjectFetch + test

* Make legacy SavedObject compatible with http.fetch exceptions

* Fix types and tests

* simple_saved_object import from src/core/server

* server imports from root instead of server/types

* Make SavedObjectsService a class

* Don't pick unkown keys from server response

* Rename SavedObjectsFindResponse to SavedObjectsFindResponsePublic

* Remove err.response from SavedObjects fetch errors

* Revert "Remove err.response from SavedObjects fetch errors"

This reverts commit 61705ca361.

* Don't introduce err.response until we deprecate err.res
This commit is contained in:
Rudolf Meijering 2019-08-07 11:29:30 +02:00 • committed by GitHub
parent 4da3fb3885
commit 1995eafdb0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
167 changed files with 2586 additions and 712 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/development/core/public/kibana-plugin-public.corestart.md
View file

@ -23,5 +23,6 @@ export interface CoreStart
| [i18n](./kibana-plugin-public.corestart.i18n.md) | <code>I18nStart</code> | [I18nStart](./kibana-plugin-public.i18nstart.md) |
| [notifications](./kibana-plugin-public.corestart.notifications.md) | <code>NotificationsStart</code> | [NotificationsStart](./kibana-plugin-public.notificationsstart.md) |
| [overlays](./kibana-plugin-public.corestart.overlays.md) | <code>OverlayStart</code> | [OverlayStart](./kibana-plugin-public.overlaystart.md) |
| [savedObjects](./kibana-plugin-public.corestart.savedobjects.md) | <code>SavedObjectsStart</code> | [SavedObjectsStart](./kibana-plugin-public.savedobjectsstart.md) |
| [uiSettings](./kibana-plugin-public.corestart.uisettings.md) | <code>UiSettingsClientContract</code> | [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) |

13
docs/development/core/public/kibana-plugin-public.corestart.savedobjects.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreStart](./kibana-plugin-public.corestart.md) &gt; [savedObjects](./kibana-plugin-public.corestart.savedobjects.md)
## CoreStart.savedObjects property
[SavedObjectsStart](./kibana-plugin-public.savedobjectsstart.md)
<b>Signature:</b>
```typescript
savedObjects: SavedObjectsStart;
```

17
docs/development/core/public/kibana-plugin-public.md
View file

@ -14,6 +14,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| Class | Description |
| --- | --- |
| [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state. The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects. |
| [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) | This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md)<!-- -->.<!-- -->It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. |
| [ToastsApi](./kibana-plugin-public.toastsapi.md) | |
| [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) | |
@ -59,6 +61,19 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [OverlayStart](./kibana-plugin-public.overlaystart.md) | |
| [Plugin](./kibana-plugin-public.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
| [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md) | The available core services passed to a <code>PluginInitializer</code> |
| [SavedObject](./kibana-plugin-public.savedobject.md) | |
| [SavedObjectAttributes](./kibana-plugin-public.savedobjectattributes.md) | The data for a Saved Object is stored in the <code>attributes</code> key as either an object or an array of objects. |
| [SavedObjectReference](./kibana-plugin-public.savedobjectreference.md) | A reference to another saved object. |
| [SavedObjectsBaseOptions](./kibana-plugin-public.savedobjectsbaseoptions.md) | |
| [SavedObjectsBatchResponse](./kibana-plugin-public.savedobjectsbatchresponse.md) | |
| [SavedObjectsBulkCreateObject](./kibana-plugin-public.savedobjectsbulkcreateobject.md) | |
| [SavedObjectsBulkCreateOptions](./kibana-plugin-public.savedobjectsbulkcreateoptions.md) | |
| [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) | |
| [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) | |
| [SavedObjectsFindResponsePublic](./kibana-plugin-public.savedobjectsfindresponsepublic.md) | Return type of the Saved Objects <code>find()</code> method.<!-- -->\*Note\*: this type is different between the Public and Server Saved Objects clients. |
| [SavedObjectsMigrationVersion](./kibana-plugin-public.savedobjectsmigrationversion.md) | 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. |
| [SavedObjectsStart](./kibana-plugin-public.savedobjectsstart.md) | |
| [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) | |
| [UiSettingsState](./kibana-plugin-public.uisettingsstate.md) | |
## Type Aliases
@ -76,6 +91,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [PluginInitializer](./kibana-plugin-public.plugininitializer.md) | The <code>plugin</code> export at the root of a plugin's <code>public</code> directory should conform to this interface. |
| [PluginOpaqueId](./kibana-plugin-public.pluginopaqueid.md) | |
| [RecursiveReadonly](./kibana-plugin-public.recursivereadonly.md) | |
| [SavedObjectAttribute](./kibana-plugin-public.savedobjectattribute.md) | |
| [SavedObjectsClientContract](./kibana-plugin-public.savedobjectsclientcontract.md) | SavedObjectsClientContract as implemented by the [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) |
| [ToastInput](./kibana-plugin-public.toastinput.md) | |
| [UiSettingsClientContract](./kibana-plugin-public.uisettingsclientcontract.md) | [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) |

13
docs/development/core/public/kibana-plugin-public.savedobject.attributes.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [attributes](./kibana-plugin-public.savedobject.attributes.md)
## SavedObject.attributes property
The data for a Saved Object is stored in the `attributes` key as either an object or an array of objects.
<b>Signature:</b>
```typescript
attributes: T;
```

14
docs/development/core/public/kibana-plugin-public.savedobject.error.md Normal file
View file

@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [error](./kibana-plugin-public.savedobject.error.md)
## SavedObject.error property
<b>Signature:</b>
```typescript
error?: {
message: string;
statusCode: number;
};
```

13
docs/development/core/public/kibana-plugin-public.savedobject.id.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [id](./kibana-plugin-public.savedobject.id.md)
## SavedObject.id property
The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`
<b>Signature:</b>
```typescript
id: string;
```

26
docs/development/core/public/kibana-plugin-public.savedobject.md Normal file
View file

@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md)
## SavedObject interface
<b>Signature:</b>
```typescript
export interface SavedObject<T extends SavedObjectAttributes = any>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [attributes](./kibana-plugin-public.savedobject.attributes.md) | <code>T</code> | The data for a Saved Object is stored in the <code>attributes</code> key as either an object or an array of objects. |
| [error](./kibana-plugin-public.savedobject.error.md) | <code>{</code><br/><code> message: string;</code><br/><code> statusCode: number;</code><br/><code> }</code> | |
| [id](./kibana-plugin-public.savedobject.id.md) | <code>string</code> | The ID of this Saved Object, guaranteed to be unique for all objects of the same <code>type</code> |
| [migrationVersion](./kibana-plugin-public.savedobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | 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](./kibana-plugin-public.savedobject.references.md) | <code>SavedObjectReference[]</code> | A reference to another saved object. |
| [type](./kibana-plugin-public.savedobject.type.md) | <code>string</code> | The type of Saved Object. Each plugin can define it's own custom Saved Object types. |
| [updated\_at](./kibana-plugin-public.savedobject.updated_at.md) | <code>string</code> | Timestamp of the last time this document had been updated. |
| [version](./kibana-plugin-public.savedobject.version.md) | <code>string</code> | An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. |

13
docs/development/core/public/kibana-plugin-public.savedobject.migrationversion.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [migrationVersion](./kibana-plugin-public.savedobject.migrationversion.md)
## SavedObject.migrationVersion property
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.
<b>Signature:</b>
```typescript
migrationVersion?: SavedObjectsMigrationVersion;
```

13
docs/development/core/public/kibana-plugin-public.savedobject.references.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [references](./kibana-plugin-public.savedobject.references.md)
## SavedObject.references property
A reference to another saved object.
<b>Signature:</b>
```typescript
references: SavedObjectReference[];
```

13
docs/development/core/public/kibana-plugin-public.savedobject.type.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [type](./kibana-plugin-public.savedobject.type.md)
## SavedObject.type property
The type of Saved Object. Each plugin can define it's own custom Saved Object types.
<b>Signature:</b>
```typescript
type: string;
```

13
docs/development/core/public/kibana-plugin-public.savedobject.updated_at.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [updated\_at](./kibana-plugin-public.savedobject.updated_at.md)
## SavedObject.updated\_at property
Timestamp of the last time this document had been updated.
<b>Signature:</b>
```typescript
updated_at?: string;
```

13
docs/development/core/public/kibana-plugin-public.savedobject.version.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObject](./kibana-plugin-public.savedobject.md) &gt; [version](./kibana-plugin-public.savedobject.version.md)
## SavedObject.version property
An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control.
<b>Signature:</b>
```typescript
version?: string;
```

12
docs/development/core/public/kibana-plugin-public.savedobjectattribute.md Normal file
View file

@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectAttribute](./kibana-plugin-public.savedobjectattribute.md)
## SavedObjectAttribute type
<b>Signature:</b>
```typescript
export declare type SavedObjectAttribute = string | number | boolean | null | undefined | SavedObjectAttributes | SavedObjectAttributes[];
```

13
docs/development/core/public/kibana-plugin-public.savedobjectattributes.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectAttributes](./kibana-plugin-public.savedobjectattributes.md)
## SavedObjectAttributes interface
The data for a Saved Object is stored in the `attributes` key as either an object or an array of objects.
<b>Signature:</b>
```typescript
export interface SavedObjectAttributes
```

11
docs/development/core/public/kibana-plugin-public.savedobjectreference.id.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectReference](./kibana-plugin-public.savedobjectreference.md) &gt; [id](./kibana-plugin-public.savedobjectreference.id.md)
## SavedObjectReference.id property
<b>Signature:</b>
```typescript
id: string;
```

22
docs/development/core/public/kibana-plugin-public.savedobjectreference.md Normal file
View file

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectReference](./kibana-plugin-public.savedobjectreference.md)
## SavedObjectReference interface
A reference to another saved object.
<b>Signature:</b>
```typescript
export interface SavedObjectReference
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [id](./kibana-plugin-public.savedobjectreference.id.md) | <code>string</code> | |
| [name](./kibana-plugin-public.savedobjectreference.name.md) | <code>string</code> | |
| [type](./kibana-plugin-public.savedobjectreference.type.md) | <code>string</code> | |

11
docs/development/core/public/kibana-plugin-public.savedobjectreference.name.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectReference](./kibana-plugin-public.savedobjectreference.md) &gt; [name](./kibana-plugin-public.savedobjectreference.name.md)
## SavedObjectReference.name property
<b>Signature:</b>
```typescript
name: string;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectreference.type.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectReference](./kibana-plugin-public.savedobjectreference.md) &gt; [type](./kibana-plugin-public.savedobjectreference.type.md)
## SavedObjectReference.type property
<b>Signature:</b>
```typescript
type: string;
```

19
docs/development/core/public/kibana-plugin-public.savedobjectsbaseoptions.md Normal file
View file

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBaseOptions](./kibana-plugin-public.savedobjectsbaseoptions.md)
## SavedObjectsBaseOptions interface
<b>Signature:</b>
```typescript
export interface SavedObjectsBaseOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [namespace](./kibana-plugin-public.savedobjectsbaseoptions.namespace.md) | <code>string</code> | Specify the namespace for this operation |

13
docs/development/core/public/kibana-plugin-public.savedobjectsbaseoptions.namespace.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBaseOptions](./kibana-plugin-public.savedobjectsbaseoptions.md) &gt; [namespace](./kibana-plugin-public.savedobjectsbaseoptions.namespace.md)
## SavedObjectsBaseOptions.namespace property
Specify the namespace for this operation
<b>Signature:</b>
```typescript
namespace?: string;
```

19
docs/development/core/public/kibana-plugin-public.savedobjectsbatchresponse.md Normal file
View file

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBatchResponse](./kibana-plugin-public.savedobjectsbatchresponse.md)
## SavedObjectsBatchResponse interface
<b>Signature:</b>
```typescript
export interface SavedObjectsBatchResponse<T extends SavedObjectAttributes = SavedObjectAttributes>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [savedObjects](./kibana-plugin-public.savedobjectsbatchresponse.savedobjects.md) | <code>Array&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | |

11
docs/development/core/public/kibana-plugin-public.savedobjectsbatchresponse.savedobjects.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBatchResponse](./kibana-plugin-public.savedobjectsbatchresponse.md) &gt; [savedObjects](./kibana-plugin-public.savedobjectsbatchresponse.savedobjects.md)
## SavedObjectsBatchResponse.savedObjects property
<b>Signature:</b>
```typescript
savedObjects: Array<SimpleSavedObject<T>>;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateobject.attributes.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBulkCreateObject](./kibana-plugin-public.savedobjectsbulkcreateobject.md) &gt; [attributes](./kibana-plugin-public.savedobjectsbulkcreateobject.attributes.md)
## SavedObjectsBulkCreateObject.attributes property
<b>Signature:</b>
```typescript
attributes: T;
```

19
docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateobject.md Normal file
View file

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBulkCreateObject](./kibana-plugin-public.savedobjectsbulkcreateobject.md)
## SavedObjectsBulkCreateObject interface
<b>Signature:</b>
```typescript
export interface SavedObjectsBulkCreateObject<T extends SavedObjectAttributes = SavedObjectAttributes> extends SavedObjectsCreateOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [attributes](./kibana-plugin-public.savedobjectsbulkcreateobject.attributes.md) | <code>T</code> | |
| [type](./kibana-plugin-public.savedobjectsbulkcreateobject.type.md) | <code>string</code> | |

11
docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateobject.type.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBulkCreateObject](./kibana-plugin-public.savedobjectsbulkcreateobject.md) &gt; [type](./kibana-plugin-public.savedobjectsbulkcreateobject.type.md)
## SavedObjectsBulkCreateObject.type property
<b>Signature:</b>
```typescript
type: string;
```

19
docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateoptions.md Normal file
View file

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBulkCreateOptions](./kibana-plugin-public.savedobjectsbulkcreateoptions.md)
## SavedObjectsBulkCreateOptions interface
<b>Signature:</b>
```typescript
export interface SavedObjectsBulkCreateOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [overwrite](./kibana-plugin-public.savedobjectsbulkcreateoptions.overwrite.md) | <code>boolean</code> | If a document with the given <code>id</code> already exists, overwrite it's contents (default=false). |

13
docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateoptions.overwrite.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsBulkCreateOptions](./kibana-plugin-public.savedobjectsbulkcreateoptions.md) &gt; [overwrite](./kibana-plugin-public.savedobjectsbulkcreateoptions.overwrite.md)
## SavedObjectsBulkCreateOptions.overwrite property
If a document with the given `id` already exists, overwrite it's contents (default=false).
<b>Signature:</b>
```typescript
overwrite?: boolean;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectsclient.bulkcreate.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) &gt; [bulkCreate](./kibana-plugin-public.savedobjectsclient.bulkcreate.md)
## SavedObjectsClient.bulkCreate property
Creates multiple documents at once
<b>Signature:</b>
```typescript
bulkCreate: (objects?: SavedObjectsBulkCreateObject<SavedObjectAttributes>[], options?: SavedObjectsBulkCreateOptions) => Promise<SavedObjectsBatchResponse<SavedObjectAttributes>>;
```

21
docs/development/core/public/kibana-plugin-public.savedobjectsclient.bulkget.md Normal file
View file

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) &gt; [bulkGet](./kibana-plugin-public.savedobjectsclient.bulkget.md)
## SavedObjectsClient.bulkGet property
Returns an array of objects by id
<b>Signature:</b>
```typescript
bulkGet: (objects?: {
id: string;
type: string;
}[]) => Promise<SavedObjectsBatchResponse<SavedObjectAttributes>>;
```
## Example
bulkGet(\[ { id: 'one', type: 'config' }<!-- -->, { id: 'foo', type: 'index-pattern' } \])

13
docs/development/core/public/kibana-plugin-public.savedobjectsclient.create.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) &gt; [create](./kibana-plugin-public.savedobjectsclient.create.md)
## SavedObjectsClient.create property
Persists an object
<b>Signature:</b>
```typescript
create: <T extends SavedObjectAttributes>(type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise<SimpleSavedObject<T>>;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectsclient.delete.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) &gt; [delete](./kibana-plugin-public.savedobjectsclient.delete.md)
## SavedObjectsClient.delete property
Deletes an object
<b>Signature:</b>
```typescript
delete: (type: string, id: string) => Promise<{}>;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectsclient.find.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) &gt; [find](./kibana-plugin-public.savedobjectsclient.find.md)
## SavedObjectsClient.find property
Search for objects
<b>Signature:</b>
```typescript
find: <T extends SavedObjectAttributes>(options?: Pick<SavedObjectFindOptionsServer, "search" | "type" | "defaultSearchOperator" | "searchFields" | "sortField" | "hasReference" | "page" | "perPage" | "fields">) => Promise<SavedObjectsFindResponsePublic<T>>;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectsclient.get.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) &gt; [get](./kibana-plugin-public.savedobjectsclient.get.md)
## SavedObjectsClient.get property
Fetches a single object
<b>Signature:</b>
```typescript
get: <T extends SavedObjectAttributes>(type: string, id: string) => Promise<SimpleSavedObject<T>>;
```

35
docs/development/core/public/kibana-plugin-public.savedobjectsclient.md Normal file
View file

@ -0,0 +1,35 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md)
## SavedObjectsClient class
Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state. The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects.
<b>Signature:</b>
```typescript
export declare class SavedObjectsClient
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [bulkCreate](./kibana-plugin-public.savedobjectsclient.bulkcreate.md) | | <code>(objects?: SavedObjectsBulkCreateObject&lt;SavedObjectAttributes&gt;[], options?: SavedObjectsBulkCreateOptions) =&gt; Promise&lt;SavedObjectsBatchResponse&lt;SavedObjectAttributes&gt;&gt;</code> | Creates multiple documents at once |
| [bulkGet](./kibana-plugin-public.savedobjectsclient.bulkget.md) | | <code>(objects?: {</code><br/><code> id: string;</code><br/><code> type: string;</code><br/><code> }[]) =&gt; Promise&lt;SavedObjectsBatchResponse&lt;SavedObjectAttributes&gt;&gt;</code> | Returns an array of objects by id |
| [create](./kibana-plugin-public.savedobjectsclient.create.md) | | <code>&lt;T extends SavedObjectAttributes&gt;(type: string, attributes: T, options?: SavedObjectsCreateOptions) =&gt; Promise&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | Persists an object |
| [delete](./kibana-plugin-public.savedobjectsclient.delete.md) | | <code>(type: string, id: string) =&gt; Promise&lt;{}&gt;</code> | Deletes an object |
| [find](./kibana-plugin-public.savedobjectsclient.find.md) | | <code>&lt;T extends SavedObjectAttributes&gt;(options?: Pick&lt;SavedObjectFindOptionsServer, &quot;search&quot; &#124; &quot;type&quot; &#124; &quot;defaultSearchOperator&quot; &#124; &quot;searchFields&quot; &#124; &quot;sortField&quot; &#124; &quot;hasReference&quot; &#124; &quot;page&quot; &#124; &quot;perPage&quot; &#124; &quot;fields&quot;&gt;) =&gt; Promise&lt;SavedObjectsFindResponsePublic&lt;T&gt;&gt;</code> | Search for objects |
| [get](./kibana-plugin-public.savedobjectsclient.get.md) | | <code>&lt;T extends SavedObjectAttributes&gt;(type: string, id: string) =&gt; Promise&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | Fetches a single object |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [update(type, id, attributes, { version, migrationVersion, references })](./kibana-plugin-public.savedobjectsclient.update.md) | | Updates an object |
## 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.

28
docs/development/core/public/kibana-plugin-public.savedobjectsclient.update.md Normal file
View file

@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) &gt; [update](./kibana-plugin-public.savedobjectsclient.update.md)
## SavedObjectsClient.update() method
Updates an object
<b>Signature:</b>
```typescript
update<T extends SavedObjectAttributes>(type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions): Promise<SimpleSavedObject<T>>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>string</code> | |
| id | <code>string</code> | |
| attributes | <code>T</code> | |
| { version, migrationVersion, references } | <code>SavedObjectsUpdateOptions</code> | |
<b>Returns:</b>
`Promise<SimpleSavedObject<T>>`

13
docs/development/core/public/kibana-plugin-public.savedobjectsclientcontract.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsClientContract](./kibana-plugin-public.savedobjectsclientcontract.md)
## SavedObjectsClientContract type
SavedObjectsClientContract as implemented by the [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md)
<b>Signature:</b>
```typescript
export declare type SavedObjectsClientContract = PublicMethodsOf<SavedObjectsClient>;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectscreateoptions.id.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) &gt; [id](./kibana-plugin-public.savedobjectscreateoptions.id.md)
## SavedObjectsCreateOptions.id property
(Not recommended) Specify an id instead of having the saved objects service generate one for you.
<b>Signature:</b>
```typescript
id?: string;
```

22
docs/development/core/public/kibana-plugin-public.savedobjectscreateoptions.md Normal file
View file

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md)
## SavedObjectsCreateOptions interface
<b>Signature:</b>
```typescript
export interface SavedObjectsCreateOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [id](./kibana-plugin-public.savedobjectscreateoptions.id.md) | <code>string</code> | (Not recommended) Specify an id instead of having the saved objects service generate one for you. |
| [migrationVersion](./kibana-plugin-public.savedobjectscreateoptions.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | 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. |
| [overwrite](./kibana-plugin-public.savedobjectscreateoptions.overwrite.md) | <code>boolean</code> | If a document with the given <code>id</code> already exists, overwrite it's contents (default=false). |
| [references](./kibana-plugin-public.savedobjectscreateoptions.references.md) | <code>SavedObjectReference[]</code> | |

13
docs/development/core/public/kibana-plugin-public.savedobjectscreateoptions.migrationversion.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) &gt; [migrationVersion](./kibana-plugin-public.savedobjectscreateoptions.migrationversion.md)
## SavedObjectsCreateOptions.migrationVersion property
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.
<b>Signature:</b>
```typescript
migrationVersion?: SavedObjectsMigrationVersion;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectscreateoptions.overwrite.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) &gt; [overwrite](./kibana-plugin-public.savedobjectscreateoptions.overwrite.md)
## SavedObjectsCreateOptions.overwrite property
If a document with the given `id` already exists, overwrite it's contents (default=false).
<b>Signature:</b>
```typescript
overwrite?: boolean;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectscreateoptions.references.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) &gt; [references](./kibana-plugin-public.savedobjectscreateoptions.references.md)
## SavedObjectsCreateOptions.references property
<b>Signature:</b>
```typescript
references?: SavedObjectReference[];
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.defaultsearchoperator.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [defaultSearchOperator](./kibana-plugin-public.savedobjectsfindoptions.defaultsearchoperator.md)
## SavedObjectsFindOptions.defaultSearchOperator property
<b>Signature:</b>
```typescript
defaultSearchOperator?: 'AND' | 'OR';
```

18
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.fields.md Normal file
View file

@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [fields](./kibana-plugin-public.savedobjectsfindoptions.fields.md)
## SavedObjectsFindOptions.fields property
An array of fields to include in the results
<b>Signature:</b>
```typescript
fields?: string[];
```
## Example
SavedObjects.find(<!-- -->{<!-- -->type: 'dashboard', fields: \['attributes.name', 'attributes.location'\]<!-- -->}<!-- -->)

14
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.hasreference.md Normal file
View file

@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [hasReference](./kibana-plugin-public.savedobjectsfindoptions.hasreference.md)
## SavedObjectsFindOptions.hasReference property
<b>Signature:</b>
```typescript
hasReference?: {
type: string;
id: string;
};
```

28
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.md Normal file
View file

@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md)
## SavedObjectsFindOptions interface
<b>Signature:</b>
```typescript
export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [defaultSearchOperator](./kibana-plugin-public.savedobjectsfindoptions.defaultsearchoperator.md) | <code>'AND' &#124; 'OR'</code> | |
| [fields](./kibana-plugin-public.savedobjectsfindoptions.fields.md) | <code>string[]</code> | An array of fields to include in the results |
| [hasReference](./kibana-plugin-public.savedobjectsfindoptions.hasreference.md) | <code>{</code><br/><code> type: string;</code><br/><code> id: string;</code><br/><code> }</code> | |
| [page](./kibana-plugin-public.savedobjectsfindoptions.page.md) | <code>number</code> | |
| [perPage](./kibana-plugin-public.savedobjectsfindoptions.perpage.md) | <code>number</code> | |
| [search](./kibana-plugin-public.savedobjectsfindoptions.search.md) | <code>string</code> | Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String <code>query</code> argument for more information |
| [searchFields](./kibana-plugin-public.savedobjectsfindoptions.searchfields.md) | <code>string[]</code> | The fields to perform the parsed query against. See Elasticsearch Simple Query String <code>fields</code> argument for more information |
| [sortField](./kibana-plugin-public.savedobjectsfindoptions.sortfield.md) | <code>string</code> | |
| [sortOrder](./kibana-plugin-public.savedobjectsfindoptions.sortorder.md) | <code>string</code> | |
| [type](./kibana-plugin-public.savedobjectsfindoptions.type.md) | <code>string &#124; string[]</code> | |

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.page.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [page](./kibana-plugin-public.savedobjectsfindoptions.page.md)
## SavedObjectsFindOptions.page property
<b>Signature:</b>
```typescript
page?: number;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.perpage.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [perPage](./kibana-plugin-public.savedobjectsfindoptions.perpage.md)
## SavedObjectsFindOptions.perPage property
<b>Signature:</b>
```typescript
perPage?: number;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.search.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [search](./kibana-plugin-public.savedobjectsfindoptions.search.md)
## SavedObjectsFindOptions.search property
Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information
<b>Signature:</b>
```typescript
search?: string;
```

13
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.searchfields.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [searchFields](./kibana-plugin-public.savedobjectsfindoptions.searchfields.md)
## SavedObjectsFindOptions.searchFields property
The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information
<b>Signature:</b>
```typescript
searchFields?: string[];
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.sortfield.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [sortField](./kibana-plugin-public.savedobjectsfindoptions.sortfield.md)
## SavedObjectsFindOptions.sortField property
<b>Signature:</b>
```typescript
sortField?: string;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.sortorder.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [sortOrder](./kibana-plugin-public.savedobjectsfindoptions.sortorder.md)
## SavedObjectsFindOptions.sortOrder property
<b>Signature:</b>
```typescript
sortOrder?: string;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindoptions.type.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindOptions](./kibana-plugin-public.savedobjectsfindoptions.md) &gt; [type](./kibana-plugin-public.savedobjectsfindoptions.type.md)
## SavedObjectsFindOptions.type property
<b>Signature:</b>
```typescript
type?: string | string[];
```

24
docs/development/core/public/kibana-plugin-public.savedobjectsfindresponsepublic.md Normal file
View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindResponsePublic](./kibana-plugin-public.savedobjectsfindresponsepublic.md)
## SavedObjectsFindResponsePublic interface
Return type of the Saved Objects `find()` method.
\*Note\*: this type is different between the Public and Server Saved Objects clients.
<b>Signature:</b>
```typescript
export interface SavedObjectsFindResponsePublic<T extends SavedObjectAttributes = SavedObjectAttributes> extends SavedObjectsBatchResponse<T>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [page](./kibana-plugin-public.savedobjectsfindresponsepublic.page.md) | <code>number</code> | |
| [perPage](./kibana-plugin-public.savedobjectsfindresponsepublic.perpage.md) | <code>number</code> | |
| [total](./kibana-plugin-public.savedobjectsfindresponsepublic.total.md) | <code>number</code> | |

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindresponsepublic.page.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindResponsePublic](./kibana-plugin-public.savedobjectsfindresponsepublic.md) &gt; [page](./kibana-plugin-public.savedobjectsfindresponsepublic.page.md)
## SavedObjectsFindResponsePublic.page property
<b>Signature:</b>
```typescript
page: number;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindresponsepublic.perpage.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindResponsePublic](./kibana-plugin-public.savedobjectsfindresponsepublic.md) &gt; [perPage](./kibana-plugin-public.savedobjectsfindresponsepublic.perpage.md)
## SavedObjectsFindResponsePublic.perPage property
<b>Signature:</b>
```typescript
perPage: number;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsfindresponsepublic.total.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsFindResponsePublic](./kibana-plugin-public.savedobjectsfindresponsepublic.md) &gt; [total](./kibana-plugin-public.savedobjectsfindresponsepublic.total.md)
## SavedObjectsFindResponsePublic.total property
<b>Signature:</b>
```typescript
total: number;
```

18
docs/development/core/public/kibana-plugin-public.savedobjectsmigrationversion.md Normal file
View file

@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsMigrationVersion](./kibana-plugin-public.savedobjectsmigrationversion.md)
## SavedObjectsMigrationVersion interface
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.
<b>Signature:</b>
```typescript
export interface SavedObjectsMigrationVersion
```
## Example
migrationVersion: { dashboard: '7.1.1', space: '6.6.6', }

13
docs/development/core/public/kibana-plugin-public.savedobjectsstart.client.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsStart](./kibana-plugin-public.savedobjectsstart.md) &gt; [client](./kibana-plugin-public.savedobjectsstart.client.md)
## SavedObjectsStart.client property
[SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md)
<b>Signature:</b>
```typescript
client: SavedObjectsClientContract;
```

19
docs/development/core/public/kibana-plugin-public.savedobjectsstart.md Normal file
View file

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsStart](./kibana-plugin-public.savedobjectsstart.md)
## SavedObjectsStart interface
<b>Signature:</b>
```typescript
export interface SavedObjectsStart
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [client](./kibana-plugin-public.savedobjectsstart.client.md) | <code>SavedObjectsClientContract</code> | [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) |

21
docs/development/core/public/kibana-plugin-public.savedobjectsupdateoptions.md Normal file
View file

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md)
## SavedObjectsUpdateOptions interface
<b>Signature:</b>
```typescript
export interface SavedObjectsUpdateOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [migrationVersion](./kibana-plugin-public.savedobjectsupdateoptions.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | 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](./kibana-plugin-public.savedobjectsupdateoptions.references.md) | <code>SavedObjectReference[]</code> | |
| [version](./kibana-plugin-public.savedobjectsupdateoptions.version.md) | <code>string</code> | |

13
docs/development/core/public/kibana-plugin-public.savedobjectsupdateoptions.migrationversion.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) &gt; [migrationVersion](./kibana-plugin-public.savedobjectsupdateoptions.migrationversion.md)
## SavedObjectsUpdateOptions.migrationVersion property
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.
<b>Signature:</b>
```typescript
migrationVersion?: SavedObjectsMigrationVersion;
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsupdateoptions.references.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) &gt; [references](./kibana-plugin-public.savedobjectsupdateoptions.references.md)
## SavedObjectsUpdateOptions.references property
<b>Signature:</b>
```typescript
references?: SavedObjectReference[];
```

11
docs/development/core/public/kibana-plugin-public.savedobjectsupdateoptions.version.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) &gt; [version](./kibana-plugin-public.savedobjectsupdateoptions.version.md)
## SavedObjectsUpdateOptions.version property
<b>Signature:</b>
```typescript
version?: string;
```

21
docs/development/core/public/kibana-plugin-public.simplesavedobject.(constructor).md Normal file
View file

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [(constructor)](./kibana-plugin-public.simplesavedobject.(constructor).md)
## SimpleSavedObject.(constructor)
Constructs a new instance of the `SimpleSavedObject` class
<b>Signature:</b>
```typescript
constructor(client: SavedObjectsClient, { id, type, version, attributes, error, references, migrationVersion }: SavedObjectType<T>);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| client | <code>SavedObjectsClient</code> | |
| { id, type, version, attributes, error, references, migrationVersion } | <code>SavedObjectType&lt;T&gt;</code> | |

11
docs/development/core/public/kibana-plugin-public.simplesavedobject._version.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [\_version](./kibana-plugin-public.simplesavedobject._version.md)
## SimpleSavedObject.\_version property
<b>Signature:</b>
```typescript
_version?: SavedObjectType<T>['version'];
```

11
docs/development/core/public/kibana-plugin-public.simplesavedobject.attributes.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [attributes](./kibana-plugin-public.simplesavedobject.attributes.md)
## SimpleSavedObject.attributes property
<b>Signature:</b>
```typescript
attributes: T;
```

15
docs/development/core/public/kibana-plugin-public.simplesavedobject.delete.md Normal file
View file

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [delete](./kibana-plugin-public.simplesavedobject.delete.md)
## SimpleSavedObject.delete() method
<b>Signature:</b>
```typescript
delete(): Promise<{}>;
```
<b>Returns:</b>
`Promise<{}>`

11
docs/development/core/public/kibana-plugin-public.simplesavedobject.error.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [error](./kibana-plugin-public.simplesavedobject.error.md)
## SimpleSavedObject.error property
<b>Signature:</b>
```typescript
error: SavedObjectType<T>['error'];
```

22
docs/development/core/public/kibana-plugin-public.simplesavedobject.get.md Normal file
View file

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [get](./kibana-plugin-public.simplesavedobject.get.md)
## SimpleSavedObject.get() method
<b>Signature:</b>
```typescript
get(key: string): any;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | |
<b>Returns:</b>
`any`

22
docs/development/core/public/kibana-plugin-public.simplesavedobject.has.md Normal file
View file

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [has](./kibana-plugin-public.simplesavedobject.has.md)
## SimpleSavedObject.has() method
<b>Signature:</b>
```typescript
has(key: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | |
<b>Returns:</b>
`boolean`

11
docs/development/core/public/kibana-plugin-public.simplesavedobject.id.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [id](./kibana-plugin-public.simplesavedobject.id.md)
## SimpleSavedObject.id property
<b>Signature:</b>
```typescript
id: SavedObjectType<T>['id'];
```

44
docs/development/core/public/kibana-plugin-public.simplesavedobject.md Normal file
View file

@ -0,0 +1,44 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md)
## SimpleSavedObject class
This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md)<!-- -->.
It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations.
<b>Signature:</b>
```typescript
export declare class SimpleSavedObject<T extends SavedObjectAttributes>
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(client, { id, type, version, attributes, error, references, migrationVersion })](./kibana-plugin-public.simplesavedobject.(constructor).md) | | Constructs a new instance of the <code>SimpleSavedObject</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_version](./kibana-plugin-public.simplesavedobject._version.md) | | <code>SavedObjectType&lt;T&gt;['version']</code> | |
| [attributes](./kibana-plugin-public.simplesavedobject.attributes.md) | | <code>T</code> | |
| [error](./kibana-plugin-public.simplesavedobject.error.md) | | <code>SavedObjectType&lt;T&gt;['error']</code> | |
| [id](./kibana-plugin-public.simplesavedobject.id.md) | | <code>SavedObjectType&lt;T&gt;['id']</code> | |
| [migrationVersion](./kibana-plugin-public.simplesavedobject.migrationversion.md) | | <code>SavedObjectType&lt;T&gt;['migrationVersion']</code> | |
| [references](./kibana-plugin-public.simplesavedobject.references.md) | | <code>SavedObjectType&lt;T&gt;['references']</code> | |
| [type](./kibana-plugin-public.simplesavedobject.type.md) | | <code>SavedObjectType&lt;T&gt;['type']</code> | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [delete()](./kibana-plugin-public.simplesavedobject.delete.md) | | |
| [get(key)](./kibana-plugin-public.simplesavedobject.get.md) | | |
| [has(key)](./kibana-plugin-public.simplesavedobject.has.md) | | |
| [save()](./kibana-plugin-public.simplesavedobject.save.md) | | |
| [set(key, value)](./kibana-plugin-public.simplesavedobject.set.md) | | |

11
docs/development/core/public/kibana-plugin-public.simplesavedobject.migrationversion.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [migrationVersion](./kibana-plugin-public.simplesavedobject.migrationversion.md)
## SimpleSavedObject.migrationVersion property
<b>Signature:</b>
```typescript
migrationVersion: SavedObjectType<T>['migrationVersion'];
```

11
docs/development/core/public/kibana-plugin-public.simplesavedobject.references.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [references](./kibana-plugin-public.simplesavedobject.references.md)
## SimpleSavedObject.references property
<b>Signature:</b>
```typescript
references: SavedObjectType<T>['references'];
```

15
docs/development/core/public/kibana-plugin-public.simplesavedobject.save.md Normal file
View file

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [save](./kibana-plugin-public.simplesavedobject.save.md)
## SimpleSavedObject.save() method
<b>Signature:</b>
```typescript
save(): Promise<SimpleSavedObject<T>>;
```
<b>Returns:</b>
`Promise<SimpleSavedObject<T>>`

23
docs/development/core/public/kibana-plugin-public.simplesavedobject.set.md Normal file
View file

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [set](./kibana-plugin-public.simplesavedobject.set.md)
## SimpleSavedObject.set() method
<b>Signature:</b>
```typescript
set(key: string, value: any): T;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | |
| value | <code>any</code> | |
<b>Returns:</b>
`T`

11
docs/development/core/public/kibana-plugin-public.simplesavedobject.type.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [SimpleSavedObject](./kibana-plugin-public.simplesavedobject.md) &gt; [type](./kibana-plugin-public.simplesavedobject.type.md)
## SimpleSavedObject.type property
<b>Signature:</b>
```typescript
type: SavedObjectType<T>['type'];
```

10
docs/development/core/server/kibana-plugin-server.md
View file

@ -63,7 +63,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [RouteConfig](./kibana-plugin-server.routeconfig.md) | Route specific configuration. |
| [RouteConfigOptions](./kibana-plugin-server.routeconfigoptions.md) | Additional route options. |
| [SavedObject](./kibana-plugin-server.savedobject.md) | |
| [SavedObjectAttributes](./kibana-plugin-server.savedobjectattributes.md) | |
| [SavedObjectAttributes](./kibana-plugin-server.savedobjectattributes.md) | The data for a Saved Object is stored in the <code>attributes</code> key as either an object or an array of objects. |
| [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md) | A reference to another saved object. |
| [SavedObjectsBaseOptions](./kibana-plugin-server.savedobjectsbaseoptions.md) | |
| [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) | |
@ -74,7 +74,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsCreateOptions](./kibana-plugin-server.savedobjectscreateoptions.md) | |
| [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) | Options controlling the export operation. |
| [SavedObjectsFindOptions](./kibana-plugin-server.savedobjectsfindoptions.md) | |
| [SavedObjectsFindResponse](./kibana-plugin-server.savedobjectsfindresponse.md) | |
| [SavedObjectsFindResponse](./kibana-plugin-server.savedobjectsfindresponse.md) | Return type of the Saved Objects <code>find()</code> method.<!-- -->\*Note\*: this type is different between the Public and Server Saved Objects clients. |
| [SavedObjectsImportConflictError](./kibana-plugin-server.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. |
| [SavedObjectsImportError](./kibana-plugin-server.savedobjectsimporterror.md) | Represents a failure to import. |
| [SavedObjectsImportMissingReferencesError](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.md) | Represents a failure to import due to missing references. |
@ -83,7 +83,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsImportRetry](./kibana-plugin-server.savedobjectsimportretry.md) | Describes a retry operation for importing a saved object. |
| [SavedObjectsImportUnknownError](./kibana-plugin-server.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. |
| [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-server.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. |
| [SavedObjectsMigrationVersion](./kibana-plugin-server.savedobjectsmigrationversion.md) | A dictionary of saved object type -<!-- -->&gt; version used to determine what migrations need to be applied to a saved object. |
| [SavedObjectsMigrationLogger](./kibana-plugin-server.savedobjectsmigrationlogger.md) | |
| [SavedObjectsMigrationVersion](./kibana-plugin-server.savedobjectsmigrationversion.md) | 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. |
| [SavedObjectsRawDoc](./kibana-plugin-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. |
| [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. |
| [SavedObjectsService](./kibana-plugin-server.savedobjectsservice.md) | |
@ -125,6 +126,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [RequestHandler](./kibana-plugin-server.requesthandler.md) | A function executed when route path matched requested resource path. Request handler is expected to return a result of one of [KibanaResponseFactory](./kibana-plugin-server.kibanaresponsefactory.md) functions. |
| [ResponseError](./kibana-plugin-server.responseerror.md) | Error message and optional data send to the client in case of error. |
| [RouteMethod](./kibana-plugin-server.routemethod.md) | The set of common HTTP methods supported by Kibana routing. |
| [SavedObjectsClientContract](./kibana-plugin-server.savedobjectsclientcontract.md) | \#\# SavedObjectsClient errors<!-- -->Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:<!-- -->1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md)<!-- -->Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the <code>isXYZError()</code> helpers exposed at <code>SavedObjectsErrorHelpers</code> should be used to understand and manage error responses from the <code>SavedObjectsClient</code>.<!-- -->Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for <code>error.body.error.type</code> or doing substring checks on <code>error.body.error.reason</code>, just use the helpers to understand the meaning of the error:<!-- -->\`\`\`<!-- -->js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }<!-- -->if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }<!-- -->// always rethrow the error unless you handle it throw error; \`\`\`<!-- -->\#\#\# 404s from missing index<!-- -->From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistance and that index might be missing.<!-- -->At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.<!-- -->From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.<!-- -->\#\#\# 503s from missing index<!-- -->Unlike all other methods, create requests are supposed to succeed even when the Kibana index does not exist because it will be automatically created by elasticsearch. When that is not the case it is because Elasticsearch's <code>action.auto_create_index</code> setting prevents it from being created automatically so we throw a special 503 with the intention of informing the user that their Elasticsearch settings need to be updated.<!-- -->See [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) |
| [SavedObjectAttribute](./kibana-plugin-server.savedobjectattribute.md) | |
| [SavedObjectsClientContract](./kibana-plugin-server.savedobjectsclientcontract.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.<!-- -->\#\# SavedObjectsClient errors<!-- -->Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:<!-- -->1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md)<!-- -->Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the <code>isXYZError()</code> helpers exposed at <code>SavedObjectsErrorHelpers</code> should be used to understand and manage error responses from the <code>SavedObjectsClient</code>.<!-- -->Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for <code>error.body.error.type</code> or doing substring checks on <code>error.body.error.reason</code>, just use the helpers to understand the meaning of the error:<!-- -->\`\`\`<!-- -->js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }<!-- -->if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }<!-- -->// always rethrow the error unless you handle it throw error; \`\`\`<!-- -->\#\#\# 404s from missing index<!-- -->From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistance and that index might be missing.<!-- -->At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.<!-- -->From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.<!-- -->\#\#\# 503s from missing index<!-- -->Unlike all other methods, create requests are supposed to succeed even when the Kibana index does not exist because it will be automatically created by elasticsearch. When that is not the case it is because Elasticsearch's <code>action.auto_create_index</code> setting prevents it from being created automatically so we throw a special 503 with the intention of informing the user that their Elasticsearch settings need to be updated.<!-- -->See [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) |
| [SavedObjectsClientWrapperFactory](./kibana-plugin-server.savedobjectsclientwrapperfactory.md) | Describes the factory used to create instances of Saved Objects Client Wrappers. |

2
docs/development/core/server/kibana-plugin-server.savedobject.attributes.md
View file

@ -4,6 +4,8 @@
## SavedObject.attributes property
The data for a Saved Object is stored in the `attributes` key as either an object or an array of objects.
<b>Signature:</b>
```typescript

2
docs/development/core/server/kibana-plugin-server.savedobject.id.md
View file

@ -4,6 +4,8 @@
## SavedObject.id property
The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`
<b>Signature:</b>
```typescript

14
docs/development/core/server/kibana-plugin-server.savedobject.md
View file

@ -15,12 +15,12 @@ export interface SavedObject<T extends SavedObjectAttributes = any>
| Property | Type | Description |
| --- | --- | --- |
| [attributes](./kibana-plugin-server.savedobject.attributes.md) | <code>T</code> | |
| [attributes](./kibana-plugin-server.savedobject.attributes.md) | <code>T</code> | The data for a Saved Object is stored in the <code>attributes</code> key as either an object or an array of objects. |
| [error](./kibana-plugin-server.savedobject.error.md) | <code>{</code><br/><code> message: string;</code><br/><code> statusCode: number;</code><br/><code> }</code> | |
| [id](./kibana-plugin-server.savedobject.id.md) | <code>string</code> | |
| [migrationVersion](./kibana-plugin-server.savedobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | |
| [references](./kibana-plugin-server.savedobject.references.md) | <code>SavedObjectReference[]</code> | |
| [type](./kibana-plugin-server.savedobject.type.md) | <code>string</code> | |
| [updated\_at](./kibana-plugin-server.savedobject.updated_at.md) | <code>string</code> | |
| [version](./kibana-plugin-server.savedobject.version.md) | <code>string</code> | |
| [id](./kibana-plugin-server.savedobject.id.md) | <code>string</code> | The ID of this Saved Object, guaranteed to be unique for all objects of the same <code>type</code> |
| [migrationVersion](./kibana-plugin-server.savedobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | 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](./kibana-plugin-server.savedobject.references.md) | <code>SavedObjectReference[]</code> | A reference to another saved object. |
| [type](./kibana-plugin-server.savedobject.type.md) | <code>string</code> | The type of Saved Object. Each plugin can define it's own custom Saved Object types. |
| [updated\_at](./kibana-plugin-server.savedobject.updated_at.md) | <code>string</code> | Timestamp of the last time this document had been updated. |
| [version](./kibana-plugin-server.savedobject.version.md) | <code>string</code> | An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control. |

2
docs/development/core/server/kibana-plugin-server.savedobject.migrationversion.md
View file

@ -4,6 +4,8 @@
## SavedObject.migrationVersion property
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.
<b>Signature:</b>
```typescript

2
docs/development/core/server/kibana-plugin-server.savedobject.references.md
View file

@ -4,6 +4,8 @@
## SavedObject.references property
A reference to another saved object.
<b>Signature:</b>
```typescript

2
docs/development/core/server/kibana-plugin-server.savedobject.type.md
View file

@ -4,6 +4,8 @@
## SavedObject.type property
The type of Saved Object. Each plugin can define it's own custom Saved Object types.
<b>Signature:</b>
```typescript

2
docs/development/core/server/kibana-plugin-server.savedobject.updated_at.md
View file

@ -4,6 +4,8 @@
## SavedObject.updated\_at property
Timestamp of the last time this document had been updated.
<b>Signature:</b>
```typescript

2
docs/development/core/server/kibana-plugin-server.savedobject.version.md
View file

@ -4,6 +4,8 @@
## SavedObject.version property
An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control.
<b>Signature:</b>
```typescript

12
docs/development/core/server/kibana-plugin-server.savedobjectattribute.md Normal file
View file

@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectAttribute](./kibana-plugin-server.savedobjectattribute.md)
## SavedObjectAttribute type
<b>Signature:</b>
```typescript
export declare type SavedObjectAttribute = string | number | boolean | null | undefined | SavedObjectAttributes | SavedObjectAttributes[];
```

1
docs/development/core/server/kibana-plugin-server.savedobjectattributes.md
View file

@ -4,6 +4,7 @@
## SavedObjectAttributes interface
The data for a Saved Object is stored in the `attributes` key as either an object or an array of objects.
<b>Signature:</b>

2
docs/development/core/server/kibana-plugin-server.savedobjectsbulkcreateobject.md
View file

@ -17,7 +17,7 @@ export interface SavedObjectsBulkCreateObject<T extends SavedObjectAttributes =
| --- | --- | --- |
| [attributes](./kibana-plugin-server.savedobjectsbulkcreateobject.attributes.md) | <code>T</code> | |
| [id](./kibana-plugin-server.savedobjectsbulkcreateobject.id.md) | <code>string</code> | |
| [migrationVersion](./kibana-plugin-server.savedobjectsbulkcreateobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | |
| [migrationVersion](./kibana-plugin-server.savedobjectsbulkcreateobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | 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](./kibana-plugin-server.savedobjectsbulkcreateobject.references.md) | <code>SavedObjectReference[]</code> | |
| [type](./kibana-plugin-server.savedobjectsbulkcreateobject.type.md) | <code>string</code> | |

2
docs/development/core/server/kibana-plugin-server.savedobjectsbulkcreateobject.migrationversion.md
View file

@ -4,6 +4,8 @@
## SavedObjectsBulkCreateObject.migrationVersion property
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.
<b>Signature:</b>
```typescript

2
docs/development/core/server/kibana-plugin-server.savedobjectsclientcontract.md
View file

@ -4,6 +4,8 @@
## SavedObjectsClientContract type
Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.
\#\# SavedObjectsClient errors
Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:

2
docs/development/core/server/kibana-plugin-server.savedobjectscreateoptions.md
View file

@ -16,7 +16,7 @@ export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions
| Property | Type | Description |
| --- | --- | --- |
| [id](./kibana-plugin-server.savedobjectscreateoptions.id.md) | <code>string</code> | (not recommended) Specify an id for the document |
| [migrationVersion](./kibana-plugin-server.savedobjectscreateoptions.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | |
| [migrationVersion](./kibana-plugin-server.savedobjectscreateoptions.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | 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. |
| [overwrite](./kibana-plugin-server.savedobjectscreateoptions.overwrite.md) | <code>boolean</code> | Overwrite existing documents (defaults to false) |
| [references](./kibana-plugin-server.savedobjectscreateoptions.references.md) | <code>SavedObjectReference[]</code> | |

2
docs/development/core/server/kibana-plugin-server.savedobjectscreateoptions.migrationversion.md
View file

@ -4,6 +4,8 @@
## SavedObjectsCreateOptions.migrationVersion property
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.
<b>Signature:</b>
```typescript

7
docs/development/core/server/kibana-plugin-server.savedobjectsfindoptions.fields.md
View file

@ -4,8 +4,15 @@
## SavedObjectsFindOptions.fields property
An array of fields to include in the results
<b>Signature:</b>
```typescript
fields?: string[];
```
## Example
SavedObjects.find(<!-- -->{<!-- -->type: 'dashboard', fields: \['attributes.name', 'attributes.location'\]<!-- -->}<!-- -->)

6
docs/development/core/server/kibana-plugin-server.savedobjectsfindoptions.md
View file

@ -16,12 +16,12 @@ export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions
| Property | Type | Description |
| --- | --- | --- |
| [defaultSearchOperator](./kibana-plugin-server.savedobjectsfindoptions.defaultsearchoperator.md) | <code>'AND' &#124; 'OR'</code> | |
| [fields](./kibana-plugin-server.savedobjectsfindoptions.fields.md) | <code>string[]</code> | |
| [fields](./kibana-plugin-server.savedobjectsfindoptions.fields.md) | <code>string[]</code> | An array of fields to include in the results |
| [hasReference](./kibana-plugin-server.savedobjectsfindoptions.hasreference.md) | <code>{</code><br/><code> type: string;</code><br/><code> id: string;</code><br/><code> }</code> | |
| [page](./kibana-plugin-server.savedobjectsfindoptions.page.md) | <code>number</code> | |
| [perPage](./kibana-plugin-server.savedobjectsfindoptions.perpage.md) | <code>number</code> | |
| [search](./kibana-plugin-server.savedobjectsfindoptions.search.md) | <code>string</code> | |
| [searchFields](./kibana-plugin-server.savedobjectsfindoptions.searchfields.md) | <code>string[]</code> | see Elasticsearch Simple Query String Query field argument for more information |
| [search](./kibana-plugin-server.savedobjectsfindoptions.search.md) | <code>string</code> | Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String <code>query</code> argument for more information |
| [searchFields](./kibana-plugin-server.savedobjectsfindoptions.searchfields.md) | <code>string[]</code> | The fields to perform the parsed query against. See Elasticsearch Simple Query String <code>fields</code> argument for more information |
| [sortField](./kibana-plugin-server.savedobjectsfindoptions.sortfield.md) | <code>string</code> | |
| [sortOrder](./kibana-plugin-server.savedobjectsfindoptions.sortorder.md) | <code>string</code> | |
| [type](./kibana-plugin-server.savedobjectsfindoptions.type.md) | <code>string &#124; string[]</code> | |

2
docs/development/core/server/kibana-plugin-server.savedobjectsfindoptions.search.md
View file

@ -4,6 +4,8 @@
## SavedObjectsFindOptions.search property
Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information
<b>Signature:</b>
```typescript

2
docs/development/core/server/kibana-plugin-server.savedobjectsfindoptions.searchfields.md
View file

@ -4,7 +4,7 @@
## SavedObjectsFindOptions.searchFields property
see Elasticsearch Simple Query String Query field argument for more information
The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information
<b>Signature:</b>

3
docs/development/core/server/kibana-plugin-server.savedobjectsfindresponse.md
View file

@ -4,6 +4,9 @@
## SavedObjectsFindResponse interface
Return type of the Saved Objects `find()` method.
\*Note\*: this type is different between the Public and Server Saved Objects clients.
<b>Signature:</b>

11
docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.debug.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsMigrationLogger](./kibana-plugin-server.savedobjectsmigrationlogger.md) &gt; [debug](./kibana-plugin-server.savedobjectsmigrationlogger.debug.md)
## SavedObjectsMigrationLogger.debug property
<b>Signature:</b>
```typescript
debug: (msg: string) => void;
```

11
docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.info.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsMigrationLogger](./kibana-plugin-server.savedobjectsmigrationlogger.md) &gt; [info](./kibana-plugin-server.savedobjectsmigrationlogger.info.md)
## SavedObjectsMigrationLogger.info property
<b>Signature:</b>
```typescript
info: (msg: string) => void;
```

Some files were not shown because too many files have changed in this diff Show more