Skip to content

Commit 129780e

Browse files
dgieselaardgieselaar
committed
Merge branch 'master' of github.com:elastic/kibana into api-snapshot-testing
2 parents 5efece4 + d01598d commit 129780e

466 files changed

Lines changed: 15523 additions & 67454 deletions

File tree

Some content is hidden

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

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
2828
| [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) | |
2929
| [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) | |
3030
| [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. |
31+
| [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) | |
3132
| [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) | Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md)<!-- -->. |
3233

3334
## Enumerations

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@ export interface SavedObjectsBulkUpdateObject<T = unknown> extends Pick<SavedObj
1717
| --- | --- | --- |
1818
| [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. |
1919
| [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> |
20+
| [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>. |
2021
| [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. |
2122

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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; [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) &gt; [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md)
4+
5+
## SavedObjectsBulkUpdateObject.namespace property
6+
7+
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)<!-- -->.
8+
9+
Note: the default namespace's string representation is `'default'`<!-- -->, and its ID representation is `undefined`<!-- -->.
10+
11+
<b>Signature:</b>
12+
13+
```typescript
14+
namespace?: string;
15+
```

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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; [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md)
4+
5+
## SavedObjectsUtils class
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export declare class SavedObjectsUtils
12+
```
13+
14+
## Properties
15+
16+
| Property | Modifiers | Type | Description |
17+
| --- | --- | --- | --- |
18+
| [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>). |
19+
| [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>). |
20+

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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; [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) &gt; [namespaceIdToString](./kibana-plugin-core-server.savedobjectsutils.namespaceidtostring.md)
4+
5+
## SavedObjectsUtils.namespaceIdToString property
6+
7+
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'`<!-- -->).
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
static namespaceIdToString: (namespace?: string | undefined) => string;
13+
```

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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; [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) &gt; [namespaceStringToId](./kibana-plugin-core-server.savedobjectsutils.namespacestringtoid.md)
4+
5+
## SavedObjectsUtils.namespaceStringToId property
6+
7+
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`<!-- -->).
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
static namespaceStringToId: (namespace: string) => string | undefined;
13+
```

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## AggConfig.(constructor)
6+
7+
Constructs a new instance of the `AggConfig` class
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
constructor(aggConfigs: IAggConfigs, opts: AggConfigOptions);
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| aggConfigs | <code>IAggConfigs</code> | |
20+
| opts | <code>AggConfigOptions</code> | |
21+

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

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-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)
4+
5+
## AggConfig.aggConfigs property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
aggConfigs: IAggConfigs;
11+
```

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

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-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)
4+
5+
## AggConfig.brandNew property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
brandNew?: boolean;
11+
```

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## AggConfig.createFilter() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
createFilter(key: string, params?: {}): any;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| key | <code>string</code> | |
18+
| params | <code>{}</code> | |
19+
20+
<b>Returns:</b>
21+
22+
`any`
23+

0 commit comments

Comments
 (0)