Skip to content

Commit bbcb2b6

Browse files
committed
Merge remote-tracking branch 'upstream/master' into kbn-51406-add-abort-FTR-test
2 parents 78ae1c1 + e321f57 commit bbcb2b6

File tree

88 files changed

+3437
-1008
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+3437
-1008
lines changed

docs/api/saved-objects/find.asciidoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,14 @@ experimental[] Retrieve a paginated set of {kib} saved objects by various condit
5353
(Optional, object) Filters to objects that have a relationship with the type and ID combination.
5454

5555
`filter`::
56-
(Optional, string) The filter is a KQL string with the caveat that if you filter with an attribute from your type saved object.
57-
It should look like that savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object like `updatedAt`,
58-
you will have to define your filter like that savedObjectType.updatedAt > 2018-12-22.
56+
(Optional, string) The filter is a KQL string with the caveat that if you filter with an attribute from your saved object type,
57+
it should look like that: `savedObjectType.attributes.title: "myTitle"`. However, If you use a root attribute of a saved
58+
object such as `updated_at`, you will have to define your filter like that: `savedObjectType.updated_at > 2018-12-22`.
59+
60+
`aggs`::
61+
(Optional, string) **experimental** An aggregation structure, serialized as a string. The field format is similar to `filter`, meaning
62+
that to use a saved object type attribute in the aggregation, the `savedObjectType.attributes.title`: "myTitle"` format
63+
must be used. For root fields, the syntax is `savedObjectType.rootField`
5964

6065
NOTE: As objects change in {kib}, the results on each page of the response also
6166
change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Search for objects
99
<b>Signature:</b>
1010

1111
```typescript
12-
find: <T = unknown>(options: SavedObjectsFindOptions) => Promise<SavedObjectsFindResponsePublic<T>>;
12+
find: <T = unknown, A = unknown>(options: SavedObjectsFindOptions) => Promise<SavedObjectsFindResponsePublic<T, unknown>>;
1313
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The constructor for this class is marked as internal. Third-party code should no
2424
| [bulkGet](./kibana-plugin-core-public.savedobjectsclient.bulkget.md) | | <code>(objects?: Array&lt;{</code><br/><code> id: string;</code><br/><code> type: string;</code><br/><code> }&gt;) =&gt; Promise&lt;SavedObjectsBatchResponse&lt;unknown&gt;&gt;</code> | Returns an array of objects by id |
2525
| [create](./kibana-plugin-core-public.savedobjectsclient.create.md) | | <code>&lt;T = unknown&gt;(type: string, attributes: T, options?: SavedObjectsCreateOptions) =&gt; Promise&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | Persists an object |
2626
| [delete](./kibana-plugin-core-public.savedobjectsclient.delete.md) | | <code>(type: string, id: string, options?: SavedObjectsDeleteOptions &#124; undefined) =&gt; ReturnType&lt;SavedObjectsApi['delete']&gt;</code> | Deletes an object |
27-
| [find](./kibana-plugin-core-public.savedobjectsclient.find.md) | | <code>&lt;T = unknown&gt;(options: SavedObjectsFindOptions) =&gt; Promise&lt;SavedObjectsFindResponsePublic&lt;T&gt;&gt;</code> | Search for objects |
27+
| [find](./kibana-plugin-core-public.savedobjectsclient.find.md) | | <code>&lt;T = unknown, A = unknown&gt;(options: SavedObjectsFindOptions) =&gt; Promise&lt;SavedObjectsFindResponsePublic&lt;T, unknown&gt;&gt;</code> | Search for objects |
2828
| [get](./kibana-plugin-core-public.savedobjectsclient.get.md) | | <code>&lt;T = unknown&gt;(type: string, id: string) =&gt; Promise&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | Fetches a single object |
2929

3030
## Methods
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) &gt; [aggregations](./kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md)
4+
5+
## SavedObjectsFindResponsePublic.aggregations property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
aggregations?: A;
11+
```

docs/development/core/public/kibana-plugin-core-public.savedobjectsfindresponsepublic.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ Return type of the Saved Objects `find()` method.
1111
<b>Signature:</b>
1212

1313
```typescript
14-
export interface SavedObjectsFindResponsePublic<T = unknown> extends SavedObjectsBatchResponse<T>
14+
export interface SavedObjectsFindResponsePublic<T = unknown, A = unknown> extends SavedObjectsBatchResponse<T>
1515
```
1616
1717
## Properties
1818
1919
| Property | Type | Description |
2020
| --- | --- | --- |
21+
| [aggregations](./kibana-plugin-core-public.savedobjectsfindresponsepublic.aggregations.md) | <code>A</code> | |
2122
| [page](./kibana-plugin-core-public.savedobjectsfindresponsepublic.page.md) | <code>number</code> | |
2223
| [perPage](./kibana-plugin-core-public.savedobjectsfindresponsepublic.perpage.md) | <code>number</code> | |
2324
| [total](./kibana-plugin-core-public.savedobjectsfindresponsepublic.total.md) | <code>number</code> | |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Find all SavedObjects matching the search query
99
<b>Signature:</b>
1010

1111
```typescript
12-
find<T = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T>>;
12+
find<T = unknown, A = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T, A>>;
1313
```
1414
1515
## Parameters
@@ -20,5 +20,5 @@ find<T = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindRes
2020
2121
<b>Returns:</b>
2222
23-
`Promise<SavedObjectsFindResponse<T>>`
23+
`Promise<SavedObjectsFindResponse<T, A>>`
2424
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsFindResponse](./kibana-plugin-core-server.savedobjectsfindresponse.md) &gt; [aggregations](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md)
4+
5+
## SavedObjectsFindResponse.aggregations property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
aggregations?: A;
11+
```

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ Return type of the Saved Objects `find()` method.
1111
<b>Signature:</b>
1212

1313
```typescript
14-
export interface SavedObjectsFindResponse<T = unknown>
14+
export interface SavedObjectsFindResponse<T = unknown, A = unknown>
1515
```
1616

1717
## Properties
1818

1919
| Property | Type | Description |
2020
| --- | --- | --- |
21+
| [aggregations](./kibana-plugin-core-server.savedobjectsfindresponse.aggregations.md) | <code>A</code> | |
2122
| [page](./kibana-plugin-core-server.savedobjectsfindresponse.page.md) | <code>number</code> | |
2223
| [per\_page](./kibana-plugin-core-server.savedobjectsfindresponse.per_page.md) | <code>number</code> | |
2324
| [pit\_id](./kibana-plugin-core-server.savedobjectsfindresponse.pit_id.md) | <code>string</code> | |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<b>Signature:</b>
88

99
```typescript
10-
find<T = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T>>;
10+
find<T = unknown, A = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T, A>>;
1111
```
1212
1313
## Parameters
@@ -18,7 +18,7 @@ find<T = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindRes
1818
1919
<b>Returns:</b>
2020
21-
`Promise<SavedObjectsFindResponse<T>>`
21+
`Promise<SavedObjectsFindResponse<T, A>>`
2222
2323
{<!-- -->promise<!-- -->} - { saved\_objects: \[{ id, type, version, attributes }<!-- -->\], total, per\_page, page }
2424

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Creates an empty response for a find operation. This is only intended to be used
99
<b>Signature:</b>
1010

1111
```typescript
12-
static createEmptyFindResponse: <T>({ page, perPage, }: SavedObjectsFindOptions) => SavedObjectsFindResponse<T>;
12+
static createEmptyFindResponse: <T, A>({ page, perPage, }: SavedObjectsFindOptions) => SavedObjectsFindResponse<T, A>;
1313
```

0 commit comments

Comments
 (0)