Merge branch 'master' into alerts/improve-find-pref

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

@@ -28,6 +28,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) |  |
 |  [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) |  |
 |  [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) | A serializer that can be used to manually convert [raw](./kibana-plugin-core-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) documents to the other kind. |
+|  [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) |  |
 |  [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) | Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md)<!-- -->. |
 
 ## Enumerations

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

@@ -17,5 +17,6 @@ export interface SavedObjectsBulkUpdateObject<T = unknown> extends Pick<SavedObj
 |  --- | --- | --- |
 |  [attributes](./kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md) | <code>Partial&lt;T&gt;</code> | The data for a Saved Object is stored as an object in the <code>attributes</code> property. |
 |  [id](./kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md) | <code>string</code> | The ID of this Saved Object, guaranteed to be unique for all objects of the same <code>type</code> |
+|  [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) | <code>string</code> | Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md)<!-- -->.<!-- -->Note: the default namespace's string representation is <code>'default'</code>, and its ID representation is <code>undefined</code>. |
 |  [type](./kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md) | <code>string</code> | The type of this Saved Object. Each plugin can define it's own custom Saved Object types. |
 

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) &gt; [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md)
+
+## SavedObjectsBulkUpdateObject.namespace property
+
+Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md)<!-- -->.
+
+Note: the default namespace's string representation is `'default'`<!-- -->, and its ID representation is `undefined`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+namespace?: string;
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md)
+
+## SavedObjectsUtils class
+
+
+<b>Signature:</b>
+
+```typescript
+export declare class SavedObjectsUtils 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [namespaceIdToString](./kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md) | <code>static</code> | <code>(namespace?: string &#124; undefined) =&gt; string</code> | Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the <code>undefined</code> namespace ID (which has a namespace string of <code>'default'</code>). |
+|  [namespaceStringToId](./kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md) | <code>static</code> | <code>(namespace: string) =&gt; string &#124; undefined</code> | Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the <code>'default'</code> namespace string (which has a namespace ID of <code>undefined</code>). |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) &gt; [namespaceIdToString](./kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md)
+
+## SavedObjectsUtils.namespaceIdToString property
+
+Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the `undefined` namespace ID (which has a namespace string of `'default'`<!-- -->).
+
+<b>Signature:</b>
+
+```typescript
+static namespaceIdToString: (namespace?: string | undefined) => string;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) &gt; [namespaceStringToId](./kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md)
+
+## SavedObjectsUtils.namespaceStringToId property
+
+Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the `'default'` namespace string (which has a namespace ID of `undefined`<!-- -->).
+
+<b>Signature:</b>
+
+```typescript
+static namespaceStringToId: (namespace: string) => string | undefined;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig._constructor_.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.aggconfig._constructor_.md)
+
+## AggConfig.(constructor)
+
+Constructs a new instance of the `AggConfig` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(aggConfigs: IAggConfigs, opts: AggConfigOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  aggConfigs | <code>IAggConfigs</code> |  |
+|  opts | <code>AggConfigOptions</code> |  |
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.aggconfigs.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.brandnew.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.createfilter.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [createFilter](./kibana-plugin-plugins-data-public.aggconfig.createfilter.md)
+
+## AggConfig.createFilter() method
+
+<b>Signature:</b>
+
+```typescript
+createFilter(key: string, params?: {}): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | <code>string</code> |  |
+|  params | <code>{}</code> |  |
+
+<b>Returns:</b>
+
+`any`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.enabled.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.ensureids.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [ensureIds](./kibana-plugin-plugins-data-public.aggconfig.ensureids.md)
+
+## AggConfig.ensureIds() method
+
+Ensure that all of the objects in the list have ids, the objects and list are modified by reference.
+
+<b>Signature:</b>
+
+```typescript
+static ensureIds(list: any[]): any[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  list | <code>any[]</code> |  |
+
+<b>Returns:</b>
+
+`any[]`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.fieldistimefield.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [fieldIsTimeField](./kibana-plugin-plugins-data-public.aggconfig.fieldistimefield.md)
+
+## AggConfig.fieldIsTimeField() method
+
+<b>Signature:</b>
+
+```typescript
+fieldIsTimeField(): boolean | "" | undefined;
+```
+<b>Returns:</b>
+
+`boolean | "" | undefined`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.fieldname.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [fieldName](./kibana-plugin-plugins-data-public.aggconfig.fieldname.md)
+
+## AggConfig.fieldName() method
+
+<b>Signature:</b>
+
+```typescript
+fieldName(): any;
+```
+<b>Returns:</b>
+
+`any`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getaggparams.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getAggParams](./kibana-plugin-plugins-data-public.aggconfig.getaggparams.md)
+
+## AggConfig.getAggParams() method
+
+<b>Signature:</b>
+
+```typescript
+getAggParams(): import("./param_types/agg").AggParamType<AggConfig>[];
+```
+<b>Returns:</b>
+
+`import("./param_types/agg").AggParamType<AggConfig>[]`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getfield.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getField](./kibana-plugin-plugins-data-public.aggconfig.getfield.md)
+
+## AggConfig.getField() method
+
+<b>Signature:</b>
+
+```typescript
+getField(): any;
+```
+<b>Returns:</b>
+
+`any`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getfielddisplayname.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getFieldDisplayName](./kibana-plugin-plugins-data-public.aggconfig.getfielddisplayname.md)
+
+## AggConfig.getFieldDisplayName() method
+
+<b>Signature:</b>
+
+```typescript
+getFieldDisplayName(): any;
+```
+<b>Returns:</b>
+
+`any`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getindexpattern.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getIndexPattern](./kibana-plugin-plugins-data-public.aggconfig.getindexpattern.md)
+
+## AggConfig.getIndexPattern() method
+
+<b>Signature:</b>
+
+```typescript
+getIndexPattern(): import("../../../public").IndexPattern;
+```
+<b>Returns:</b>
+
+`import("../../../public").IndexPattern`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getkey.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getparam.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getrequestaggs.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getresponseaggs.md

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

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.gettimerange.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getTimeRange](./kibana-plugin-plugins-data-public.aggconfig.gettimerange.md)
+
+## AggConfig.getTimeRange() method
+
+<b>Signature:</b>
+
+```typescript
+getTimeRange(): import("../../../public").TimeRange | undefined;
+```
+<b>Returns:</b>
+
+`import("../../../public").TimeRange | undefined`
+