add docs

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

@@ -0,0 +1,20 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.indexpatternsservice._constructor_.md)
+
+## IndexPatternsService.(constructor)
+
+Constructs a new instance of the `IndexPatternsService` class
+
+<b>Signature:</b>
+
+```typescript
+constructor({ uiSettings, savedObjectsClient, apiClient, fieldFormats, onNotification, onError, onRedirectNoIndexPattern, }: IndexPatternsServiceDeps);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  { uiSettings, savedObjectsClient, apiClient, fieldFormats, onNotification, onError, onRedirectNoIndexPattern, } | <code>IndexPatternsServiceDeps</code> |  |
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.clearcache.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [clearCache](./kibana-plugin-plugins-data-public.indexpatternsservice.clearcache.md)
+
+## IndexPatternsService.clearCache property
+
+Clear index pattern list cache
+
+<b>Signature:</b>
+
+```typescript
+clearCache: (id?: string | undefined) => void;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.create.md

@@ -0,0 +1,25 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [create](./kibana-plugin-plugins-data-public.indexpatternsservice.create.md)
+
+## IndexPatternsService.create() method
+
+Create a new index pattern instance
+
+<b>Signature:</b>
+
+```typescript
+create(spec: IndexPatternSpec, skipFetchFields?: boolean): Promise<IndexPattern>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  spec | <code>IndexPatternSpec</code> |  |
+|  skipFetchFields | <code>boolean</code> |  |
+
+<b>Returns:</b>
+
+`Promise<IndexPattern>`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.createandsave.md

@@ -0,0 +1,26 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [createAndSave](./kibana-plugin-plugins-data-public.indexpatternsservice.createandsave.md)
+
+## IndexPatternsService.createAndSave() method
+
+Create a new index pattern and save it right away
+
+<b>Signature:</b>
+
+```typescript
+createAndSave(spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean): Promise<IndexPattern>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  spec | <code>IndexPatternSpec</code> |  |
+|  override | <code>boolean</code> |  |
+|  skipFetchFields | <code>boolean</code> |  |
+
+<b>Returns:</b>
+
+`Promise<IndexPattern>`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.createsavedobject.md

@@ -0,0 +1,25 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [createSavedObject](./kibana-plugin-plugins-data-public.indexpatternsservice.createsavedobject.md)
+
+## IndexPatternsService.createSavedObject() method
+
+Save a new index pattern
+
+<b>Signature:</b>
+
+```typescript
+createSavedObject(indexPattern: IndexPattern, override?: boolean): Promise<IndexPattern>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  indexPattern | <code>IndexPattern</code> |  |
+|  override | <code>boolean</code> |  |
+
+<b>Returns:</b>
+
+`Promise<IndexPattern>`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.delete.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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [delete](./kibana-plugin-plugins-data-public.indexpatternsservice.delete.md)
+
+## IndexPatternsService.delete() method
+
+Deletes an index pattern from .kibana index
+
+<b>Signature:</b>
+
+```typescript
+delete(indexPatternId: string): Promise<{}>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  indexPatternId | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`Promise<{}>`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.ensuredefaultindexpattern.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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [ensureDefaultIndexPattern](./kibana-plugin-plugins-data-public.indexpatternsservice.ensuredefaultindexpattern.md)
+
+## IndexPatternsService.ensureDefaultIndexPattern property
+
+<b>Signature:</b>
+
+```typescript
+ensureDefaultIndexPattern: EnsureDefaultIndexPattern;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.fieldarraytomap.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [fieldArrayToMap](./kibana-plugin-plugins-data-public.indexpatternsservice.fieldarraytomap.md)
+
+## IndexPatternsService.fieldArrayToMap property
+
+Converts field array to map
+
+<b>Signature:</b>
+
+```typescript
+fieldArrayToMap: (fields: FieldSpec[]) => Record<string, FieldSpec>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.get.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [get](./kibana-plugin-plugins-data-public.indexpatternsservice.get.md)
+
+## IndexPatternsService.get property
+
+Get an index pattern by id. Cache optimized
+
+<b>Signature:</b>
+
+```typescript
+get: (id: string) => Promise<IndexPattern>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.getcache.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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [getCache](./kibana-plugin-plugins-data-public.indexpatternsservice.getcache.md)
+
+## IndexPatternsService.getCache property
+
+<b>Signature:</b>
+
+```typescript
+getCache: () => Promise<SavedObject<IndexPatternSavedObjectAttrs>[] | null | undefined>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.getdefault.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [getDefault](./kibana-plugin-plugins-data-public.indexpatternsservice.getdefault.md)
+
+## IndexPatternsService.getDefault property
+
+Get default index pattern
+
+<b>Signature:</b>
+
+```typescript
+getDefault: () => Promise<IndexPattern | null>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforindexpattern.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [getFieldsForIndexPattern](./kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforindexpattern.md)
+
+## IndexPatternsService.getFieldsForIndexPattern property
+
+Get field list by providing an index patttern (or spec)
+
+<b>Signature:</b>
+
+```typescript
+getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions) => Promise<any>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforwildcard.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [getFieldsForWildcard](./kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforwildcard.md)
+
+## IndexPatternsService.getFieldsForWildcard property
+
+Get field list by providing { pattern }
+
+<b>Signature:</b>
+
+```typescript
+getFieldsForWildcard: (options?: GetFieldsOptions) => Promise<any>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.getids.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [getIds](./kibana-plugin-plugins-data-public.indexpatternsservice.getids.md)
+
+## IndexPatternsService.getIds property
+
+Get list of index pattern ids
+
+<b>Signature:</b>
+
+```typescript
+getIds: (refresh?: boolean) => Promise<string[]>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.gettitles.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [getTitles](./kibana-plugin-plugins-data-public.indexpatternsservice.gettitles.md)
+
+## IndexPatternsService.getTitles property
+
+Get list of index pattern titles
+
+<b>Signature:</b>
+
+```typescript
+getTitles: (refresh?: boolean) => Promise<string[]>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.md

@@ -0,0 +1,46 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md)
+
+## IndexPatternsService class
+
+<b>Signature:</b>
+
+```typescript
+export declare class IndexPatternsService 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)({ uiSettings, savedObjectsClient, apiClient, fieldFormats, onNotification, onError, onRedirectNoIndexPattern, })](./kibana-plugin-plugins-data-public.indexpatternsservice._constructor_.md) |  | Constructs a new instance of the <code>IndexPatternsService</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [clearCache](./kibana-plugin-plugins-data-public.indexpatternsservice.clearcache.md) |  | <code>(id?: string &#124; undefined) =&gt; void</code> | Clear index pattern list cache |
+|  [ensureDefaultIndexPattern](./kibana-plugin-plugins-data-public.indexpatternsservice.ensuredefaultindexpattern.md) |  | <code>EnsureDefaultIndexPattern</code> |  |
+|  [fieldArrayToMap](./kibana-plugin-plugins-data-public.indexpatternsservice.fieldarraytomap.md) |  | <code>(fields: FieldSpec[]) =&gt; Record&lt;string, FieldSpec&gt;</code> | Converts field array to map |
+|  [get](./kibana-plugin-plugins-data-public.indexpatternsservice.get.md) |  | <code>(id: string) =&gt; Promise&lt;IndexPattern&gt;</code> | Get an index pattern by id. Cache optimized |
+|  [getCache](./kibana-plugin-plugins-data-public.indexpatternsservice.getcache.md) |  | <code>() =&gt; Promise&lt;SavedObject&lt;IndexPatternSavedObjectAttrs&gt;[] &#124; null &#124; undefined&gt;</code> |  |
+|  [getDefault](./kibana-plugin-plugins-data-public.indexpatternsservice.getdefault.md) |  | <code>() =&gt; Promise&lt;IndexPattern &#124; null&gt;</code> | Get default index pattern |
+|  [getFieldsForIndexPattern](./kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforindexpattern.md) |  | <code>(indexPattern: IndexPattern &#124; IndexPatternSpec, options?: GetFieldsOptions) =&gt; Promise&lt;any&gt;</code> | Get field list by providing an index patttern (or spec) |
+|  [getFieldsForWildcard](./kibana-plugin-plugins-data-public.indexpatternsservice.getfieldsforwildcard.md) |  | <code>(options?: GetFieldsOptions) =&gt; Promise&lt;any&gt;</code> | Get field list by providing { pattern } |
+|  [getIds](./kibana-plugin-plugins-data-public.indexpatternsservice.getids.md) |  | <code>(refresh?: boolean) =&gt; Promise&lt;string[]&gt;</code> | Get list of index pattern ids |
+|  [getTitles](./kibana-plugin-plugins-data-public.indexpatternsservice.gettitles.md) |  | <code>(refresh?: boolean) =&gt; Promise&lt;string[]&gt;</code> | Get list of index pattern titles |
+|  [refreshFields](./kibana-plugin-plugins-data-public.indexpatternsservice.refreshfields.md) |  | <code>(indexPattern: IndexPattern) =&gt; Promise&lt;void&gt;</code> | Refresh field list for a given index pattern |
+|  [savedObjectToSpec](./kibana-plugin-plugins-data-public.indexpatternsservice.savedobjecttospec.md) |  | <code>(savedObject: SavedObject&lt;IndexPatternAttributes&gt;) =&gt; IndexPatternSpec</code> | Converts index pattern saved object to index pattern spec |
+|  [setDefault](./kibana-plugin-plugins-data-public.indexpatternsservice.setdefault.md) |  | <code>(id: string, force?: boolean) =&gt; Promise&lt;void&gt;</code> | Optionally set default index pattern, unless force = true |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [create(spec, skipFetchFields)](./kibana-plugin-plugins-data-public.indexpatternsservice.create.md) |  | Create a new index pattern instance |
+|  [createAndSave(spec, override, skipFetchFields)](./kibana-plugin-plugins-data-public.indexpatternsservice.createandsave.md) |  | Create a new index pattern and save it right away |
+|  [createSavedObject(indexPattern, override)](./kibana-plugin-plugins-data-public.indexpatternsservice.createsavedobject.md) |  | Save a new index pattern |
+|  [delete(indexPatternId)](./kibana-plugin-plugins-data-public.indexpatternsservice.delete.md) |  | Deletes an index pattern from .kibana index |
+|  [updateSavedObject(indexPattern, saveAttempts)](./kibana-plugin-plugins-data-public.indexpatternsservice.updatesavedobject.md) |  | Save existing index pattern. Will attempt to merge differences if there are conflicts |
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.refreshfields.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [refreshFields](./kibana-plugin-plugins-data-public.indexpatternsservice.refreshfields.md)
+
+## IndexPatternsService.refreshFields property
+
+Refresh field list for a given index pattern
+
+<b>Signature:</b>
+
+```typescript
+refreshFields: (indexPattern: IndexPattern) => Promise<void>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.savedobjecttospec.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [savedObjectToSpec](./kibana-plugin-plugins-data-public.indexpatternsservice.savedobjecttospec.md)
+
+## IndexPatternsService.savedObjectToSpec property
+
+Converts index pattern saved object to index pattern spec
+
+<b>Signature:</b>
+
+```typescript
+savedObjectToSpec: (savedObject: SavedObject<IndexPatternAttributes>) => IndexPatternSpec;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.setdefault.md

@@ -0,0 +1,13 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [setDefault](./kibana-plugin-plugins-data-public.indexpatternsservice.setdefault.md)
+
+## IndexPatternsService.setDefault property
+
+Optionally set default index pattern, unless force = true
+
+<b>Signature:</b>
+
+```typescript
+setDefault: (id: string, force?: boolean) => Promise<void>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternsservice.updatesavedobject.md

@@ -0,0 +1,25 @@
+<!-- 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; [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) &gt; [updateSavedObject](./kibana-plugin-plugins-data-public.indexpatternsservice.updatesavedobject.md)
+
+## IndexPatternsService.updateSavedObject() method
+
+Save existing index pattern. Will attempt to merge differences if there are conflicts
+
+<b>Signature:</b>
+
+```typescript
+updateSavedObject(indexPattern: IndexPattern, saveAttempts?: number): Promise<void | Error>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  indexPattern | <code>IndexPattern</code> |  |
+|  saveAttempts | <code>number</code> |  |
+
+<b>Returns:</b>
+
+`Promise<void | Error>`
+