-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
34 changed files
with
486 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
docs/development/core/public/kibana-plugin-public.savedobjectsbatchresponse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsBatchResponse](./kibana-plugin-public.savedobjectsbatchresponse.md) | ||
|
||
## SavedObjectsBatchResponse interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface SavedObjectsBatchResponse<T extends SavedObjectAttributes = SavedObjectAttributes> | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [savedObjects](./kibana-plugin-public.savedobjectsbatchresponse.savedobjects.md) | <code>Array<SimpleSavedObject<T>></code> | | | ||
|
11 changes: 11 additions & 0 deletions
11
...ment/core/public/kibana-plugin-public.savedobjectsbatchresponse.savedobjects.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsBatchResponse](./kibana-plugin-public.savedobjectsbatchresponse.md) > [savedObjects](./kibana-plugin-public.savedobjectsbatchresponse.savedobjects.md) | ||
|
||
## SavedObjectsBatchResponse.savedObjects property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
savedObjects: Array<SimpleSavedObject<T>>; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...ent/core/public/kibana-plugin-public.savedobjectsbulkcreateobject.attributes.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-public.savedobjectsbulkcreateobject.md) > [attributes](./kibana-plugin-public.savedobjectsbulkcreateobject.attributes.md) | ||
|
||
## SavedObjectsBulkCreateObject.attributes property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
attributes: T; | ||
``` |
19 changes: 19 additions & 0 deletions
19
docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateobject.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-public.savedobjectsbulkcreateobject.md) | ||
|
||
## SavedObjectsBulkCreateObject interface | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface SavedObjectsBulkCreateObject<T extends SavedObjectAttributes = SavedObjectAttributes> extends SavedObjectsCreateOptions | ||
``` | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [attributes](./kibana-plugin-public.savedobjectsbulkcreateobject.attributes.md) | <code>T</code> | | | ||
| [type](./kibana-plugin-public.savedobjectsbulkcreateobject.type.md) | <code>string</code> | | | ||
11 changes: 11 additions & 0 deletions
11
...velopment/core/public/kibana-plugin-public.savedobjectsbulkcreateobject.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsBulkCreateObject](./kibana-plugin-public.savedobjectsbulkcreateobject.md) > [type](./kibana-plugin-public.savedobjectsbulkcreateobject.type.md) | ||
|
||
## SavedObjectsBulkCreateObject.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: string; | ||
``` |
19 changes: 19 additions & 0 deletions
19
docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateoptions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsBulkCreateOptions](./kibana-plugin-public.savedobjectsbulkcreateoptions.md) | ||
|
||
## SavedObjectsBulkCreateOptions interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface SavedObjectsBulkCreateOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [overwrite](./kibana-plugin-public.savedobjectsbulkcreateoptions.overwrite.md) | <code>boolean</code> | If a document with the given <code>id</code> already exists, overwrite it's contents (default=false). | | ||
|
13 changes: 13 additions & 0 deletions
13
...ent/core/public/kibana-plugin-public.savedobjectsbulkcreateoptions.overwrite.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsBulkCreateOptions](./kibana-plugin-public.savedobjectsbulkcreateoptions.md) > [overwrite](./kibana-plugin-public.savedobjectsbulkcreateoptions.overwrite.md) | ||
|
||
## SavedObjectsBulkCreateOptions.overwrite property | ||
|
||
If a document with the given `id` already exists, overwrite it's contents (default=false). | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
overwrite?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.savedobjectscreateoptions.id.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) > [id](./kibana-plugin-public.savedobjectscreateoptions.id.md) | ||
|
||
## SavedObjectsCreateOptions.id property | ||
|
||
(Not recommended) Specify an id instead of having the saved objects service generate one for you. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
id?: string; | ||
``` |
22 changes: 22 additions & 0 deletions
22
docs/development/core/public/kibana-plugin-public.savedobjectscreateoptions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) | ||
|
||
## SavedObjectsCreateOptions interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface SavedObjectsCreateOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [id](./kibana-plugin-public.savedobjectscreateoptions.id.md) | <code>string</code> | (Not recommended) Specify an id instead of having the saved objects service generate one for you. | | ||
| [migrationVersion](./kibana-plugin-public.savedobjectscreateoptions.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | | | ||
| [overwrite](./kibana-plugin-public.savedobjectscreateoptions.overwrite.md) | <code>boolean</code> | If a document with the given <code>id</code> already exists, overwrite it's contents (default=false). | | ||
| [references](./kibana-plugin-public.savedobjectscreateoptions.references.md) | <code>SavedObjectReference[]</code> | | | ||
|
11 changes: 11 additions & 0 deletions
11
.../core/public/kibana-plugin-public.savedobjectscreateoptions.migrationversion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) > [migrationVersion](./kibana-plugin-public.savedobjectscreateoptions.migrationversion.md) | ||
|
||
## SavedObjectsCreateOptions.migrationVersion property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
migrationVersion?: SavedObjectsMigrationVersion; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...lopment/core/public/kibana-plugin-public.savedobjectscreateoptions.overwrite.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) > [overwrite](./kibana-plugin-public.savedobjectscreateoptions.overwrite.md) | ||
|
||
## SavedObjectsCreateOptions.overwrite property | ||
|
||
If a document with the given `id` already exists, overwrite it's contents (default=false). | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
overwrite?: boolean; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...opment/core/public/kibana-plugin-public.savedobjectscreateoptions.references.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsCreateOptions](./kibana-plugin-public.savedobjectscreateoptions.md) > [references](./kibana-plugin-public.savedobjectscreateoptions.references.md) | ||
|
||
## SavedObjectsCreateOptions.references property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
references?: SavedObjectReference[]; | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/development/core/public/kibana-plugin-public.savedobjectsfindresponse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsFindResponse](./kibana-plugin-public.savedobjectsfindresponse.md) | ||
|
||
## SavedObjectsFindResponse interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface SavedObjectsFindResponse<T extends SavedObjectAttributes = SavedObjectAttributes> extends SavedObjectsBatchResponse<T> | ||
``` | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [page](./kibana-plugin-public.savedobjectsfindresponse.page.md) | <code>number</code> | | | ||
| [perPage](./kibana-plugin-public.savedobjectsfindresponse.perpage.md) | <code>number</code> | | | ||
| [total](./kibana-plugin-public.savedobjectsfindresponse.total.md) | <code>number</code> | | | ||
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-public.savedobjectsfindresponse.page.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsFindResponse](./kibana-plugin-public.savedobjectsfindresponse.md) > [page](./kibana-plugin-public.savedobjectsfindresponse.page.md) | ||
|
||
## SavedObjectsFindResponse.page property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
page: number; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...evelopment/core/public/kibana-plugin-public.savedobjectsfindresponse.perpage.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsFindResponse](./kibana-plugin-public.savedobjectsfindresponse.md) > [perPage](./kibana-plugin-public.savedobjectsfindresponse.perpage.md) | ||
|
||
## SavedObjectsFindResponse.perPage property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
perPage: number; | ||
``` |
11 changes: 11 additions & 0 deletions
11
.../development/core/public/kibana-plugin-public.savedobjectsfindresponse.total.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsFindResponse](./kibana-plugin-public.savedobjectsfindresponse.md) > [total](./kibana-plugin-public.savedobjectsfindresponse.total.md) | ||
|
||
## SavedObjectsFindResponse.total property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
total: number; | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/development/core/public/kibana-plugin-public.savedobjectsupdateoptions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) | ||
|
||
## SavedObjectsUpdateOptions interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface SavedObjectsUpdateOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [migrationVersion](./kibana-plugin-public.savedobjectsupdateoptions.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | | | ||
| [references](./kibana-plugin-public.savedobjectsupdateoptions.references.md) | <code>SavedObjectReference[]</code> | | | ||
| [version](./kibana-plugin-public.savedobjectsupdateoptions.version.md) | <code>string</code> | | | ||
|
11 changes: 11 additions & 0 deletions
11
.../core/public/kibana-plugin-public.savedobjectsupdateoptions.migrationversion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) > [migrationVersion](./kibana-plugin-public.savedobjectsupdateoptions.migrationversion.md) | ||
|
||
## SavedObjectsUpdateOptions.migrationVersion property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
migrationVersion?: SavedObjectsMigrationVersion; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...opment/core/public/kibana-plugin-public.savedobjectsupdateoptions.references.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) > [references](./kibana-plugin-public.savedobjectsupdateoptions.references.md) | ||
|
||
## SavedObjectsUpdateOptions.references property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
references?: SavedObjectReference[]; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...velopment/core/public/kibana-plugin-public.savedobjectsupdateoptions.version.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [SavedObjectsUpdateOptions](./kibana-plugin-public.savedobjectsupdateoptions.md) > [version](./kibana-plugin-public.savedobjectsupdateoptions.version.md) | ||
|
||
## SavedObjectsUpdateOptions.version property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
version?: string; | ||
``` |
Oops, something went wrong.