Server saved objects client through request context

docs/development/core/server/kibana-plugin-server.callapioptions.wrap401errors.md

@@ -9,5 +9,5 @@ Indicates whether `401 Unauthorized` errors returned from the Elasticsearch API
 <b>Signature:</b>
 
 ```typescript
-wrap401Errors: boolean;
+wrap401Errors?: boolean;
 ```

docs/development/core/server/kibana-plugin-server.md

@@ -20,6 +20,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [ClusterClient](./kibana-plugin-server.clusterclient.md) | Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>). |
 |  [ElasticsearchErrorHelpers](./kibana-plugin-server.elasticsearcherrorhelpers.md) | Helpers for working with errors returned from the Elasticsearch service.Since the internal data of errors are subject to change, consumers of the Elasticsearch service should always use these helpers to classify errors instead of checking error internals such as <code>body.error.header[WWW-Authenticate]</code> |
 |  [KibanaRequest](./kibana-plugin-server.kibanarequest.md) | Kibana specific abstraction for an incoming request. |
+|  [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) |  |
 |  [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) |  |
 |  [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) | Serves the same purpose as "normal" <code>ClusterClient</code> but exposes additional <code>callAsCurrentUser</code> method that doesn't use credentials of the Kibana internal user (as <code>callAsInternalUser</code> does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API |
 
@@ -65,7 +66,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [PluginManifest](./kibana-plugin-server.pluginmanifest.md) | Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. |
 |  [PluginsServiceSetup](./kibana-plugin-server.pluginsservicesetup.md) |  |
 |  [PluginsServiceStart](./kibana-plugin-server.pluginsservicestart.md) |  |
-|  [RequestHandlerContext](./kibana-plugin-server.requesthandlercontext.md) | Plugin specific context passed to a route handler. |
+|  [RequestHandlerContext](./kibana-plugin-server.requesthandlercontext.md) | Plugin specific context passed to a route handler.<!-- -->Provides the following clients: - [savedObjects.client](./kibana-plugin-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [elasticsearch.dataClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request |
 |  [RouteConfig](./kibana-plugin-server.routeconfig.md) | Route specific configuration. |
 |  [RouteConfigOptions](./kibana-plugin-server.routeconfigoptions.md) | Additional route options. |
 |  [SavedObject](./kibana-plugin-server.savedobject.md) |  |
@@ -143,6 +144,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [ResponseHeaders](./kibana-plugin-server.responseheaders.md) | Http response headers to set. |
 |  [RouteMethod](./kibana-plugin-server.routemethod.md) | The set of common HTTP methods supported by Kibana routing. |
 |  [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) |
+|  [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 [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) 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. |
 

docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md

@@ -8,6 +8,9 @@
 
 ```typescript
 core: {
+        savedObjects: {
+            client: SavedObjectsClientContract;
+        };
         elasticsearch: {
             dataClient: ScopedClusterClient;
             adminClient: ScopedClusterClient;

docs/development/core/server/kibana-plugin-server.requesthandlercontext.md

@@ -6,6 +6,8 @@
 
 Plugin specific context passed to a route handler.
 
+Provides the following clients: - [savedObjects.client](./kibana-plugin-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [elasticsearch.dataClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request
+
 <b>Signature:</b>
 
 ```typescript
@@ -16,5 +18,5 @@ export interface RequestHandlerContext
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [core](./kibana-plugin-server.requesthandlercontext.core.md) | <code>{</code><br/><code>        elasticsearch: {</code><br/><code>            dataClient: ScopedClusterClient;</code><br/><code>            adminClient: ScopedClusterClient;</code><br/><code>        };</code><br/><code>    }</code> |  |
+|  [core](./kibana-plugin-server.requesthandlercontext.core.md) | <code>{</code><br/><code>        savedObjects: {</code><br/><code>            client: SavedObjectsClientContract;</code><br/><code>        };</code><br/><code>        elasticsearch: {</code><br/><code>            dataClient: ScopedClusterClient;</code><br/><code>            adminClient: ScopedClusterClient;</code><br/><code>        };</code><br/><code>    }</code> |  |
 

docs/development/core/server/kibana-plugin-server.savedobjectsclient._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [(constructor)](./kibana-plugin-server.savedobjectsclient._constructor_.md)
+
+## SavedObjectsClient.(constructor)
+
+Constructs a new instance of the `SavedObjectsClient` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(repository: SavedObjectsRepository);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  repository | <code>SavedObjectsRepository</code> |  |
+

docs/development/core/server/kibana-plugin-server.savedobjectsclient.bulkcreate.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [bulkCreate](./kibana-plugin-server.savedobjectsclient.bulkcreate.md)
+
+## SavedObjectsClient.bulkCreate() method
+
+Persists multiple documents batched together as a single request
+
+<b>Signature:</b>
+
+```typescript
+bulkCreate<T extends SavedObjectAttributes = any>(objects: Array<SavedObjectsBulkCreateObject<T>>, options?: SavedObjectsCreateOptions): Promise<SavedObjectsBulkResponse<T>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  objects | <code>Array&lt;SavedObjectsBulkCreateObject&lt;T&gt;&gt;</code> |  |
+|  options | <code>SavedObjectsCreateOptions</code> |  |
+
+<b>Returns:</b>
+
+`Promise<SavedObjectsBulkResponse<T>>`
+

docs/development/core/server/kibana-plugin-server.savedobjectsclient.bulkget.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [bulkGet](./kibana-plugin-server.savedobjectsclient.bulkget.md)
+
+## SavedObjectsClient.bulkGet() method
+
+Returns an array of objects by id
+
+<b>Signature:</b>
+
+```typescript
+bulkGet<T extends SavedObjectAttributes = any>(objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions): Promise<SavedObjectsBulkResponse<T>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  objects | <code>SavedObjectsBulkGetObject[]</code> | an array of ids, or an array of objects containing id, type and optionally fields |
+|  options | <code>SavedObjectsBaseOptions</code> |  |
+
+<b>Returns:</b>
+
+`Promise<SavedObjectsBulkResponse<T>>`
+
+## Example
+
+bulkGet(\[ { id: 'one', type: 'config' }<!-- -->, { id: 'foo', type: 'index-pattern' } \])
+

docs/development/core/server/kibana-plugin-server.savedobjectsclient.create.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [create](./kibana-plugin-server.savedobjectsclient.create.md)
+
+## SavedObjectsClient.create() method
+
+Persists a SavedObject
+
+<b>Signature:</b>
+
+```typescript
+create<T extends SavedObjectAttributes = any>(type: string, attributes: T, options?: SavedObjectsCreateOptions): Promise<SavedObject<T>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | <code>string</code> |  |
+|  attributes | <code>T</code> |  |
+|  options | <code>SavedObjectsCreateOptions</code> |  |
+
+<b>Returns:</b>
+
+`Promise<SavedObject<T>>`
+

docs/development/core/server/kibana-plugin-server.savedobjectsclient.delete.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [delete](./kibana-plugin-server.savedobjectsclient.delete.md)
+
+## SavedObjectsClient.delete() method
+
+Deletes a SavedObject
+
+<b>Signature:</b>
+
+```typescript
+delete(type: string, id: string, options?: SavedObjectsBaseOptions): Promise<{}>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | <code>string</code> |  |
+|  id | <code>string</code> |  |
+|  options | <code>SavedObjectsBaseOptions</code> |  |
+
+<b>Returns:</b>
+
+`Promise<{}>`
+

docs/development/core/server/kibana-plugin-server.savedobjectsclient.errors.md

@@ -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; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [errors](./kibana-plugin-server.savedobjectsclient.errors.md)
+
+## SavedObjectsClient.errors property
+
+<b>Signature:</b>
+
+```typescript
+static errors: typeof SavedObjectsErrorHelpers;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsclient.find.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [find](./kibana-plugin-server.savedobjectsclient.find.md)
+
+## SavedObjectsClient.find() method
+
+Find all SavedObjects matching the search query
+
+<b>Signature:</b>
+
+```typescript
+find<T extends SavedObjectAttributes = any>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | <code>SavedObjectsFindOptions</code> |  |
+
+<b>Returns:</b>
+
+`Promise<SavedObjectsFindResponse<T>>`
+

docs/development/core/server/kibana-plugin-server.savedobjectsclient.get.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) &gt; [get](./kibana-plugin-server.savedobjectsclient.get.md)
+
+## SavedObjectsClient.get() method
+
+Retrieves a single object
+
+<b>Signature:</b>
+
+```typescript
+get<T extends SavedObjectAttributes = any>(type: string, id: string, options?: SavedObjectsBaseOptions): Promise<SavedObject<T>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | <code>string</code> | The type of SavedObject to retrieve |
+|  id | <code>string</code> | The ID of the SavedObject to retrieve |
+|  options | <code>SavedObjectsBaseOptions</code> |  |
+
+<b>Returns:</b>
+
+`Promise<SavedObject<T>>`
+

docs/development/core/server/kibana-plugin-server.savedobjectsclient.md

@@ -0,0 +1,38 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md)
+
+## SavedObjectsClient class
+
+
+<b>Signature:</b>
+
+```typescript
+export declare class SavedObjectsClient 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(repository)](./kibana-plugin-server.savedobjectsclient._constructor_.md) |  | Constructs a new instance of the <code>SavedObjectsClient</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [errors](./kibana-plugin-server.savedobjectsclient.errors.md) |  | <code>typeof SavedObjectsErrorHelpers</code> |  |
+|  [errors](./kibana-plugin-server.savedobjectsclient.errors.md) | <code>static</code> | <code>typeof SavedObjectsErrorHelpers</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [bulkCreate(objects, options)](./kibana-plugin-server.savedobjectsclient.bulkcreate.md) |  | Persists multiple documents batched together as a single request |
+|  [bulkGet(objects, options)](./kibana-plugin-server.savedobjectsclient.bulkget.md) |  | Returns an array of objects by id |
+|  [create(type, attributes, options)](./kibana-plugin-server.savedobjectsclient.create.md) |  | Persists a SavedObject |
+|  [delete(type, id, options)](./kibana-plugin-server.savedobjectsclient.delete.md) |  | Deletes a SavedObject |
+|  [find(options)](./kibana-plugin-server.savedobjectsclient.find.md) |  | Find all SavedObjects matching the search query |
+|  [get(type, id, options)](./kibana-plugin-server.savedobjectsclient.get.md) |  | Retrieves a single object |
+|  [update(type, id, attributes, options)](./kibana-plugin-server.savedobjectsclient.update.md) |  | Updates an SavedObject |
+