-
Notifications
You must be signed in to change notification settings - Fork 8.1k
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
1,706 changed files
with
38,268 additions
and
17,046 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| [[batch-reindex-queue]] | ||
| === Batch reindex queue API | ||
| ++++ | ||
| <titleabbrev>Batch reindex queue</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."] | ||
|
|
||
| Check the current reindex batch queue. | ||
|
|
||
| [[batch-reindex-queue-request]] | ||
| ==== Request | ||
|
|
||
| `GET /api/upgrade_assistant/reindex/batch/queue` | ||
|
|
||
| [[batch-reindex-queue-request-codes]] | ||
| ==== Response code | ||
|
|
||
| `200`:: | ||
| Indicates a successful call. | ||
|
|
||
| [[batch-reindex-queue-example]] | ||
| ==== Example | ||
|
|
||
| The API returns the following: | ||
|
|
||
| [source,js] | ||
| -------------------------------------------------- | ||
| { | ||
| "queue": [ <1> | ||
| { | ||
| "indexName": "index1", | ||
| "newIndexName": "reindexed-v8-index2", | ||
| "status": 3, | ||
| "lastCompletedStep": 0, | ||
| "locked": null, | ||
| "reindexTaskId": null, | ||
| "reindexTaskPercComplete": null, | ||
| "errorMessage": null, | ||
| "runningReindexCount": null, | ||
| "reindexOptions": { | ||
| "queueSettings": { | ||
| "queuedAt": 1583406985489 | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "indexName": "index2", | ||
| "newIndexName": "reindexed-v8-index2", | ||
| "status": 3, | ||
| "lastCompletedStep": 0, | ||
| "locked": null, | ||
| "reindexTaskId": null, | ||
| "reindexTaskPercComplete": null, | ||
| "errorMessage": null, | ||
| "runningReindexCount": null, | ||
| "reindexOptions": { | ||
| "queueSettings": { | ||
| "queuedAt": 1583406987334 | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| <1> Items in this array indicate reindex tasks at a given point in time and the order in which they will be executed. | ||
|
|
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,81 @@ | ||
| [[batch-start-resume-reindex]] | ||
| === Batch start or resume reindex API | ||
| ++++ | ||
| <titleabbrev>Batch start or resume reindex</titleabbrev> | ||
| ++++ | ||
|
|
||
| experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."] | ||
|
|
||
| Start or resume multiple reindexing tasks in one request. Additionally, reindexing tasks started or resumed | ||
| via the batch endpoint will be placed on a queue and executed one-by-one, which ensures that minimal cluster resources | ||
| are consumed over time. | ||
|
|
||
| [[batch-start-resume-reindex-request]] | ||
| ==== Request | ||
|
|
||
| `POST /api/upgrade_assistant/reindex/batch` | ||
|
|
||
| [[batch-start-resume-reindex-request-body]] | ||
| ==== Request body | ||
|
|
||
| `indexNames`:: | ||
| (Required, array) The list of index names to be reindexed. | ||
|
|
||
| [[batch-start-resume-reindex-codes]] | ||
| ==== Response code | ||
|
|
||
| `200`:: | ||
| Indicates a successful call. | ||
|
|
||
| [[batch-start-resume-example]] | ||
| ==== Example | ||
|
|
||
| [source,js] | ||
| -------------------------------------------------- | ||
| POST /api/upgrade_assistant/reindex/batch | ||
| { | ||
| "indexNames": [ <1> | ||
| "index1", | ||
| "index2" | ||
| ] | ||
| } | ||
| -------------------------------------------------- | ||
| <1> The order in which the indices are provided here determines the order in which the reindex tasks will be executed. | ||
|
|
||
| Similar to the <<start-resume-reindex, start or resume endpoint>>, the API returns the following: | ||
|
|
||
| [source,js] | ||
| -------------------------------------------------- | ||
| { | ||
| "enqueued": [ <1> | ||
| { | ||
| "indexName": "index1", | ||
| "newIndexName": "reindexed-v8-index1", | ||
| "status": 3, | ||
| "lastCompletedStep": 0, | ||
| "locked": null, | ||
| "reindexTaskId": null, | ||
| "reindexTaskPercComplete": null, | ||
| "errorMessage": null, | ||
| "runningReindexCount": null, | ||
| "reindexOptions": { <2> | ||
| "queueSettings": { | ||
| "queuedAt": 1583406985489 <3> | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "errors": [ <4> | ||
| { | ||
| "indexName": "index2", | ||
| "message": "Something went wrong!" | ||
| } | ||
| ] | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| <1> A list of reindex operations created, the order in the array indicates the order in which tasks will be executed. | ||
| <2> Presence of this key indicates that the reindex job will occur in the batch. | ||
| <3> A Unix timestamp of when the reindex task was placed in the queue. | ||
| <4> A list of errors that may have occurred preventing the reindex task from being created. | ||
|
|
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
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
20 changes: 20 additions & 0 deletions
20
docs/development/core/public/kibana-plugin-core-public.toastoptions.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,20 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | ||
|
|
||
| ## ToastOptions interface | ||
|
|
||
| Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| export interface ToastOptions | ||
| ``` | ||
|
|
||
| ## Properties | ||
|
|
||
| | Property | Type | Description | | ||
| | --- | --- | --- | | ||
| | [toastLifeTimeMs](./kibana-plugin-core-public.toastoptions.toastlifetimems.md) | <code>number</code> | How long should the toast remain on screen. | | ||
|
|
13 changes: 13 additions & 0 deletions
13
...velopment/core/public/kibana-plugin-core-public.toastoptions.toastlifetimems.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-core-public](./kibana-plugin-core-public.md) > [ToastOptions](./kibana-plugin-core-public.toastoptions.md) > [toastLifeTimeMs](./kibana-plugin-core-public.toastoptions.toastlifetimems.md) | ||
|
|
||
| ## ToastOptions.toastLifeTimeMs property | ||
|
|
||
| How long should the toast remain on screen. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| toastLifeTimeMs?: number; | ||
| ``` |
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
27 changes: 27 additions & 0 deletions
27
docs/development/core/public/kibana-plugin-core-public.toastsapi.addinfo.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,27 @@ | ||
| <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
|
||
| [Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ToastsApi](./kibana-plugin-core-public.toastsapi.md) > [addInfo](./kibana-plugin-core-public.toastsapi.addinfo.md) | ||
|
|
||
| ## ToastsApi.addInfo() method | ||
|
|
||
| Adds a new toast pre-configured with the info color and info icon. | ||
|
|
||
| <b>Signature:</b> | ||
|
|
||
| ```typescript | ||
| addInfo(toastOrTitle: ToastInput, options?: ToastOptions): Toast; | ||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | --- | --- | --- | | ||
| | toastOrTitle | <code>ToastInput</code> | a [ToastInput](./kibana-plugin-core-public.toastinput.md) | | ||
| | options | <code>ToastOptions</code> | a [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | | ||
|
|
||
| <b>Returns:</b> | ||
|
|
||
| `Toast` | ||
|
|
||
| a [Toast](./kibana-plugin-core-public.toast.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
Oops, something went wrong.