diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md
index 12af33756fb19d2..f429866848aa4db 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md
@@ -4,7 +4,7 @@
## Comparator type
-Used to compare state. see [useContainerSelector](./kibana-plugin-plugins-kibana_utils-common-state_containers.usecontainerselector.md)
+Used to compare state, see [useContainerSelector](./kibana-plugin-plugins-kibana_utils-common-state_containers.usecontainerselector.md).
Signature:
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md
index e05f1fb392fe6e0..ca68c47ddaa7e7b 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md
@@ -4,7 +4,7 @@
## Connect type
-Similar to `connect` from react-redux, allows to map state from state container to component's props
+Similar to `connect` from react-redux, allows to map state from state container to component's props.
Signature:
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md
index 794bf63588312f2..8aadd0a234a8af5 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md
@@ -4,7 +4,7 @@
## createStateContainer() function
-Creates a state container with transitions, but without selectors
+Creates a state container with transitions, but without selectors.
Signature:
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md
index 1946baae202f1df..bb06ca18e808adb 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md
@@ -4,7 +4,7 @@
## createStateContainer() function
-Creates a state container with transitions and selectors
+Creates a state container with transitions and selectors.
Signature:
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md
index 4f772c7c54d084d..0b05775ad1458f4 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md
@@ -4,7 +4,7 @@
## CreateStateContainerOptions.freeze property
-Function to use when freezing state. Supply identity function. If not provided, default deepFreeze is use.
+Function to use when freezing state. Supply identity function. If not provided, default `deepFreeze` is used.
Signature:
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md
index d328d306e93e1d9..8dba1b647edf405 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md
@@ -16,5 +16,5 @@ export interface CreateStateContainerOptions
| Property | Type | Description |
| --- | --- | --- |
-| [freeze](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md) | <T>(state: T) => T
| Function to use when freezing state. Supply identity function. If not provided, default deepFreeze is use. |
+| [freeze](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md) | <T>(state: T) => T
| Function to use when freezing state. Supply identity function. If not provided, default deepFreeze
is used. |
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.md
index e74ff2c6885be1e..7cabb72cecb31d1 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.md
@@ -11,8 +11,8 @@ State containers are Redux-store-like objects meant to help you manage state in
| Function | Description |
| --- | --- |
| [createStateContainer(defaultState)](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer.md) | Creates a state container without transitions and without selectors. |
-| [createStateContainer(defaultState, pureTransitions)](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md) | Creates a state container with transitions, but without selectors |
-| [createStateContainer(defaultState, pureTransitions, pureSelectors, options)](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md) | Creates a state container with transitions and selectors |
+| [createStateContainer(defaultState, pureTransitions)](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md) | Creates a state container with transitions, but without selectors. |
+| [createStateContainer(defaultState, pureTransitions, pureSelectors, options)](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md) | Creates a state container with transitions and selectors. |
## Interfaces
@@ -20,8 +20,8 @@ State containers are Redux-store-like objects meant to help you manage state in
| --- | --- |
| [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md) | Base state container shape without transitions or selectors |
| [CreateStateContainerOptions](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md) | State container options |
-| [ReduxLikeStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.reduxlikestatecontainer.md) | Fully featured state container which matches Redux store interface. Extends [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) Allows to use state container with redux libraries |
-| [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) | Fully featured state container with [Selectors](./kibana-plugin-plugins-kibana_utils-common-state_containers.selector.md) and . Extends [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md) |
+| [ReduxLikeStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.reduxlikestatecontainer.md) | Fully featured state container which matches Redux store interface. Extends [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md). Allows to use state container with redux libraries. |
+| [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) | Fully featured state container with [Selectors](./kibana-plugin-plugins-kibana_utils-common-state_containers.selector.md) and . Extends [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md). |
## Variables
@@ -36,8 +36,8 @@ State containers are Redux-store-like objects meant to help you manage state in
| Type Alias | Description |
| --- | --- |
| [BaseState](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestate.md) | Base [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) state shape |
-| [Comparator](./kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md) | Used to compare state. see [useContainerSelector](./kibana-plugin-plugins-kibana_utils-common-state_containers.usecontainerselector.md) |
-| [Connect](./kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md) | Similar to connect
from react-redux, allows to map state from state container to component's props |
+| [Comparator](./kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md) | Used to compare state, see [useContainerSelector](./kibana-plugin-plugins-kibana_utils-common-state_containers.usecontainerselector.md). |
+| [Connect](./kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md) | Similar to connect
from react-redux, allows to map state from state container to component's props. |
| [Dispatch](./kibana-plugin-plugins-kibana_utils-common-state_containers.dispatch.md) | Redux like dispatch |
| [EnsurePureSelector](./kibana-plugin-plugins-kibana_utils-common-state_containers.ensurepureselector.md) | |
| [EnsurePureTransition](./kibana-plugin-plugins-kibana_utils-common-state_containers.ensurepuretransition.md) | |
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.reduxlikestatecontainer.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.reduxlikestatecontainer.md
index 0e08119c1eae442..1229f4c2998f85f 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.reduxlikestatecontainer.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.reduxlikestatecontainer.md
@@ -4,7 +4,7 @@
## ReduxLikeStateContainer interface
-Fully featured state container which matches Redux store interface. Extends [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) Allows to use state container with redux libraries
+Fully featured state container which matches Redux store interface. Extends [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md). Allows to use state container with redux libraries.
Signature:
diff --git a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md
index 23ec1c8e5be0106..5d47540c824b0aa 100644
--- a/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md
+++ b/docs/development/plugins/kibana_utils/common/state_containers/kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md
@@ -4,7 +4,7 @@
## StateContainer interface
-Fully featured state container with [Selectors](./kibana-plugin-plugins-kibana_utils-common-state_containers.selector.md) and . Extends [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md)
+Fully featured state container with [Selectors](./kibana-plugin-plugins-kibana_utils-common-state_containers.selector.md) and . Extends [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md).
Signature:
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/index.md b/docs/development/plugins/kibana_utils/public/state_sync/index.md
index 4b345d9130bd543..5625e4a4b5eb859 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/index.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/index.md
@@ -8,5 +8,5 @@
| Package | Description |
| --- | --- |
-| [kibana-plugin-plugins-kibana\_utils-public-state\_sync](./kibana-plugin-plugins-kibana_utils-public-state_sync.md) | State syncing utilities are a set of helpers for syncing your application state with URL or browser storage.They are designed to work together with state containers (). But state containers are not required.State syncing utilities include:- util which: - Subscribes to state changes and pushes them to state storage. - Optionally subscribes to state storage changes and pushes them to state. - Two types of storage compatible with syncState
: - - Serializes state and persists it to URL's query param in rison or hashed format. Listens for state updates in the URL and pushes them back to state. - - Serializes state and persists it to browser storage.Refer [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples |
+| [kibana-plugin-plugins-kibana\_utils-public-state\_sync](./kibana-plugin-plugins-kibana_utils-public-state_sync.md) | State syncing utilities are a set of helpers for syncing your application state with browser URL or browser storage.They are designed to work together with [state containers](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_containers). But state containers are not required.State syncing utilities include:\* util which: \* Subscribes to state changes and pushes them to state storage. \* Optionally subscribes to state storage changes and pushes them to state. \* Two types of storages compatible with syncState
: \* - Serializes state and persists it to URL's query param in rison or hashed format. Listens for state updates in the URL and pushes them back to state. \* - Serializes state and persists it to browser storage.Refer [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples. |
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.flush.md b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.flush.md
index e0e6aa9be4368b9..dfeef1cdce22c6f 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.flush.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.flush.md
@@ -4,7 +4,7 @@
## IKbnUrlStateStorage.flush property
-synchronously runs any pending url updates returned boolean indicates if change occurred
+Synchronously runs any pending url updates, returned boolean indicates if change occurred.
Signature:
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md
index 56cefebd2acfe63..371f7b7c15362e9 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md
@@ -4,7 +4,11 @@
## IKbnUrlStateStorage interface
-KbnUrlStateStorage is a state storage for [syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) utility which: 1. Keeps state in sync with the URL. 2. Serializes data and stores it in the URL in one of the supported formats: \* Rison encoded. \* Hashed URL: In URL we store only the hash from the serialized state, but the state itself is stored in sessionStorage. See kibana's advanced option for more context state:storeInSessionStorage 3. Takes care of listening to the URL updates and notifies state about the updates. 4. Takes care of batching URL updates to prevent redundant browser history records. [GUIDE](https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md)
+KbnUrlStateStorage is a state storage for [syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) utility which:
+
+1. Keeps state in sync with the URL. 2. Serializes data and stores it in the URL in one of the supported formats: \* Rison encoded. \* Hashed URL: In URL we store only the hash from the serialized state, but the state itself is stored in sessionStorage. See Kibana's `state:storeInSessionStorage` advanced option for more context. 3. Takes care of listening to the URL updates and notifies state about the updates. 4. Takes care of batching URL updates to prevent redundant browser history records.
+
+[Refer to this guide for more info](https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md)
Signature:
@@ -18,7 +22,7 @@ export interface IKbnUrlStateStorage extends IStateStorage
| --- | --- | --- |
| [cancel](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.cancel.md) | () => void
| cancels any pending url updates |
| [change$](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.change_.md) | <State = unknown>(key: string) => Observable<State | null>
| |
-| [flush](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.flush.md) | (opts?: {
replace?: boolean;
}) => boolean
| synchronously runs any pending url updates returned boolean indicates if change occurred |
+| [flush](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.flush.md) | (opts?: {
replace?: boolean;
}) => boolean
| Synchronously runs any pending url updates, returned boolean indicates if change occurred. |
| [get](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.get.md) | <State = unknown>(key: string) => State | null
| |
| [set](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.set.md) | <State>(key: string, state: State, opts?: {
replace: boolean;
}) => Promise<string | undefined>
| |
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.inullablebasestatecontainer.md b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.inullablebasestatecontainer.md
index ca69609936405cb..d81694484c3c0b8 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.inullablebasestatecontainer.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.inullablebasestatecontainer.md
@@ -14,7 +14,7 @@ export interface INullableBaseStateContainer extends Ba
## Remarks
-State container for stateSync() have to accept "null" for example, set() implementation could handle null and fallback to some default state this is required to handle edge case, when state in storage becomes empty and syncing is in progress. state container will be notified about about storage becoming empty with null passed in
+State container for `stateSync()` have to accept `null` for example, `set()` implementation could handle null and fallback to some default state this is required to handle edge case, when state in storage becomes empty and syncing is in progress. State container will be notified about about storage becoming empty with null passed in.
## Properties
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.cancel.md b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.cancel.md
index ce771d52a6e60f7..13bacfae9ef56c7 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.cancel.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.cancel.md
@@ -4,7 +4,7 @@
## IStateStorage.cancel property
-Optional method to cancel any pending activity syncState() will call it, if it is provided by IStateStorage
+Optional method to cancel any pending activity [syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) will call it during destroy, if it is provided by IStateStorage
Signature:
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.md b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.md
index 2c34a185fb7b12e..82f7949dfdc0392 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.md
@@ -18,7 +18,7 @@ export interface IStateStorage
| Property | Type | Description |
| --- | --- | --- |
-| [cancel](./kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.cancel.md) | () => void
| Optional method to cancel any pending activity syncState() will call it, if it is provided by IStateStorage |
+| [cancel](./kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.cancel.md) | () => void
| Optional method to cancel any pending activity [syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) will call it during destroy, if it is provided by IStateStorage |
| [change$](./kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.change_.md) | <State = unknown>(key: string) => Observable<State | null>
| Should notify when the stored state has changed |
| [get](./kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.get.md) | <State = unknown>(key: string) => State | null
| Should retrieve state from the storage and deserialize it |
| [set](./kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.set.md) | <State>(key: string, state: State) => any
| Take in a state object, should serialise and persist |
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.md b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.md
index 2b02c98e0d60538..52919f78a035c48 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.md
@@ -4,28 +4,28 @@
## kibana-plugin-plugins-kibana\_utils-public-state\_sync package
-State syncing utilities are a set of helpers for syncing your application state with URL or browser storage.
+State syncing utilities are a set of helpers for syncing your application state with browser URL or browser storage.
-They are designed to work together with state containers (). But state containers are not required.
+They are designed to work together with [state containers](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_containers). But state containers are not required.
State syncing utilities include:
-- [syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) util which: - Subscribes to state changes and pushes them to state storage. - Optionally subscribes to state storage changes and pushes them to state. - Two types of storage compatible with `syncState`: - [IKbnUrlStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md) - Serializes state and persists it to URL's query param in rison or hashed format. Listens for state updates in the URL and pushes them back to state. - [ISessionStorageStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.isessionstoragestatestorage.md) - Serializes state and persists it to browser storage.
+\*[syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) util which: \* Subscribes to state changes and pushes them to state storage. \* Optionally subscribes to state storage changes and pushes them to state. \* Two types of storages compatible with `syncState`: \* [IKbnUrlStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md) - Serializes state and persists it to URL's query param in rison or hashed format. Listens for state updates in the URL and pushes them back to state. \* [ISessionStorageStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.isessionstoragestatestorage.md) - Serializes state and persists it to browser storage.
-Refer [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples
+Refer [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples.
## Functions
| Function | Description |
| --- | --- |
-| [syncState({ storageKey, stateStorage, stateContainer, })](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) | Utility for syncing application state wrapped in state container with some kind of storage (e.g. URL) Refer [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples |
+| [syncState({ storageKey, stateStorage, stateContainer, })](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) | Utility for syncing application state wrapped in state container with some kind of storage (e.g. URL)Go [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples. |
| [syncStates(stateSyncConfigs)](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstates.md) | |
## Interfaces
| Interface | Description |
| --- | --- |
-| [IKbnUrlStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md) | KbnUrlStateStorage is a state storage for [syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) utility which: 1. Keeps state in sync with the URL. 2. Serializes data and stores it in the URL in one of the supported formats: \* Rison encoded. \* Hashed URL: In URL we store only the hash from the serialized state, but the state itself is stored in sessionStorage. See kibana's advanced option for more context state:storeInSessionStorage 3. Takes care of listening to the URL updates and notifies state about the updates. 4. Takes care of batching URL updates to prevent redundant browser history records. [GUIDE](https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md) |
+| [IKbnUrlStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md) | KbnUrlStateStorage is a state storage for [syncState()](./kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md) utility which:1. Keeps state in sync with the URL. 2. Serializes data and stores it in the URL in one of the supported formats: \* Rison encoded. \* Hashed URL: In URL we store only the hash from the serialized state, but the state itself is stored in sessionStorage. See Kibana's state:storeInSessionStorage
advanced option for more context. 3. Takes care of listening to the URL updates and notifies state about the updates. 4. Takes care of batching URL updates to prevent redundant browser history records.[Refer to this guide for more info](https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md) |
| [INullableBaseStateContainer](./kibana-plugin-plugins-kibana_utils-public-state_sync.inullablebasestatecontainer.md) | Extension of with one constraint: set state should handle null
as incoming state |
| [ISessionStorageStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.isessionstoragestatestorage.md) | [IStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.md) for storing state in browser [guide](https://github.com/elastic/kibana/blob/master/src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md) |
| [IStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.istatestorage.md) | Any StateStorage have to implement IStateStorage interface StateStorage is responsible for: \* state serialisation / deserialization \* persisting to and retrieving from storageFor an example take a look at already implemented [IKbnUrlStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md) and [ISessionStorageStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.isessionstoragestatestorage.md) state storages |
diff --git a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md
index d095c3fffc512a4..10dc4d0e1874601 100644
--- a/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md
+++ b/docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.syncstate.md
@@ -4,7 +4,9 @@
## syncState() function
-Utility for syncing application state wrapped in state container with some kind of storage (e.g. URL) Refer [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples
+Utility for syncing application state wrapped in state container with some kind of storage (e.g. URL)
+
+Go [here](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync) for a complete guide and examples.
Signature:
@@ -24,13 +26,9 @@ export declare function syncState ({ tab: s.tab });
diff --git a/src/core/server/elasticsearch/client/client_facade.mock.ts b/src/core/server/elasticsearch/client/client_facade.mock.ts
deleted file mode 100644
index f629d9fbbe04bfa..000000000000000
--- a/src/core/server/elasticsearch/client/client_facade.mock.ts
+++ /dev/null
@@ -1,416 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { ClientFacade } from './client_facade';
-
-const createFacadeMock = () => {
- const mock: DeeplyMockedKeys = {
- transport: {
- request: jest.fn(),
- },
- /* GENERATED */
- asyncSearch: {
- delete: jest.fn(),
- get: jest.fn(),
- submit: jest.fn(),
- },
- autoscaling: {
- deleteAutoscalingPolicy: jest.fn(),
- getAutoscalingDecision: jest.fn(),
- getAutoscalingPolicy: jest.fn(),
- putAutoscalingPolicy: jest.fn(),
- },
- bulk: jest.fn(),
- cat: {
- aliases: jest.fn(),
- allocation: jest.fn(),
- count: jest.fn(),
- fielddata: jest.fn(),
- health: jest.fn(),
- help: jest.fn(),
- indices: jest.fn(),
- master: jest.fn(),
- mlDataFrameAnalytics: jest.fn(),
- mlDatafeeds: jest.fn(),
- mlJobs: jest.fn(),
- mlTrainedModels: jest.fn(),
- nodeattrs: jest.fn(),
- nodes: jest.fn(),
- pendingTasks: jest.fn(),
- plugins: jest.fn(),
- recovery: jest.fn(),
- repositories: jest.fn(),
- segments: jest.fn(),
- shards: jest.fn(),
- snapshots: jest.fn(),
- tasks: jest.fn(),
- templates: jest.fn(),
- threadPool: jest.fn(),
- transforms: jest.fn(),
- },
- ccr: {
- deleteAutoFollowPattern: jest.fn(),
- follow: jest.fn(),
- followInfo: jest.fn(),
- followStats: jest.fn(),
- forgetFollower: jest.fn(),
- getAutoFollowPattern: jest.fn(),
- pauseAutoFollowPattern: jest.fn(),
- pauseFollow: jest.fn(),
- putAutoFollowPattern: jest.fn(),
- resumeAutoFollowPattern: jest.fn(),
- resumeFollow: jest.fn(),
- stats: jest.fn(),
- unfollow: jest.fn(),
- },
- clearScroll: jest.fn(),
- cluster: {
- allocationExplain: jest.fn(),
- deleteComponentTemplate: jest.fn(),
- deleteVotingConfigExclusions: jest.fn(),
- existsComponentTemplate: jest.fn(),
- getComponentTemplate: jest.fn(),
- getSettings: jest.fn(),
- health: jest.fn(),
- pendingTasks: jest.fn(),
- postVotingConfigExclusions: jest.fn(),
- putComponentTemplate: jest.fn(),
- putSettings: jest.fn(),
- remoteInfo: jest.fn(),
- reroute: jest.fn(),
- state: jest.fn(),
- stats: jest.fn(),
- },
- count: jest.fn(),
- create: jest.fn(),
- delete: jest.fn(),
- deleteByQuery: jest.fn(),
- deleteByQueryRethrottle: jest.fn(),
- deleteScript: jest.fn(),
- enrich: {
- deletePolicy: jest.fn(),
- executePolicy: jest.fn(),
- getPolicy: jest.fn(),
- putPolicy: jest.fn(),
- stats: jest.fn(),
- },
- eql: {
- search: jest.fn(),
- },
- exists: jest.fn(),
- existsSource: jest.fn(),
- explain: jest.fn(),
- fieldCaps: jest.fn(),
- get: jest.fn(),
- getScript: jest.fn(),
- getScriptContext: jest.fn(),
- getScriptLanguages: jest.fn(),
- getSource: jest.fn(),
- graph: {
- explore: jest.fn(),
- },
- ilm: {
- deleteLifecycle: jest.fn(),
- explainLifecycle: jest.fn(),
- getLifecycle: jest.fn(),
- getStatus: jest.fn(),
- moveToStep: jest.fn(),
- putLifecycle: jest.fn(),
- removePolicy: jest.fn(),
- retry: jest.fn(),
- start: jest.fn(),
- stop: jest.fn(),
- },
- index: jest.fn(),
- indices: {
- analyze: jest.fn(),
- clearCache: jest.fn(),
- clone: jest.fn(),
- close: jest.fn(),
- create: jest.fn(),
- createDataStream: jest.fn(),
- delete: jest.fn(),
- deleteAlias: jest.fn(),
- deleteDataStream: jest.fn(),
- deleteIndexTemplate: jest.fn(),
- deleteTemplate: jest.fn(),
- exists: jest.fn(),
- existsAlias: jest.fn(),
- existsIndexTemplate: jest.fn(),
- existsTemplate: jest.fn(),
- existsType: jest.fn(),
- flush: jest.fn(),
- flushSynced: jest.fn(),
- forcemerge: jest.fn(),
- freeze: jest.fn(),
- get: jest.fn(),
- getAlias: jest.fn(),
- getDataStreams: jest.fn(),
- getFieldMapping: jest.fn(),
- getIndexTemplate: jest.fn(),
- getMapping: jest.fn(),
- getSettings: jest.fn(),
- getTemplate: jest.fn(),
- getUpgrade: jest.fn(),
- open: jest.fn(),
- putAlias: jest.fn(),
- putIndexTemplate: jest.fn(),
- putMapping: jest.fn(),
- putSettings: jest.fn(),
- putTemplate: jest.fn(),
- recovery: jest.fn(),
- refresh: jest.fn(),
- reloadSearchAnalyzers: jest.fn(),
- rollover: jest.fn(),
- segments: jest.fn(),
- shardStores: jest.fn(),
- shrink: jest.fn(),
- simulateIndexTemplate: jest.fn(),
- split: jest.fn(),
- stats: jest.fn(),
- unfreeze: jest.fn(),
- updateAliases: jest.fn(),
- upgrade: jest.fn(),
- validateQuery: jest.fn(),
- },
- info: jest.fn(),
- ingest: {
- deletePipeline: jest.fn(),
- getPipeline: jest.fn(),
- processorGrok: jest.fn(),
- putPipeline: jest.fn(),
- simulate: jest.fn(),
- },
- license: {
- delete: jest.fn(),
- get: jest.fn(),
- getBasicStatus: jest.fn(),
- getTrialStatus: jest.fn(),
- post: jest.fn(),
- postStartBasic: jest.fn(),
- postStartTrial: jest.fn(),
- },
- mget: jest.fn(),
- migration: {
- deprecations: jest.fn(),
- },
- ml: {
- closeJob: jest.fn(),
- deleteCalendar: jest.fn(),
- deleteCalendarEvent: jest.fn(),
- deleteCalendarJob: jest.fn(),
- deleteDataFrameAnalytics: jest.fn(),
- deleteDatafeed: jest.fn(),
- deleteExpiredData: jest.fn(),
- deleteFilter: jest.fn(),
- deleteForecast: jest.fn(),
- deleteJob: jest.fn(),
- deleteModelSnapshot: jest.fn(),
- deleteTrainedModel: jest.fn(),
- estimateModelMemory: jest.fn(),
- evaluateDataFrame: jest.fn(),
- explainDataFrameAnalytics: jest.fn(),
- findFileStructure: jest.fn(),
- flushJob: jest.fn(),
- forecast: jest.fn(),
- getBuckets: jest.fn(),
- getCalendarEvents: jest.fn(),
- getCalendars: jest.fn(),
- getCategories: jest.fn(),
- getDataFrameAnalytics: jest.fn(),
- getDataFrameAnalyticsStats: jest.fn(),
- getDatafeedStats: jest.fn(),
- getDatafeeds: jest.fn(),
- getFilters: jest.fn(),
- getInfluencers: jest.fn(),
- getJobStats: jest.fn(),
- getJobs: jest.fn(),
- getModelSnapshots: jest.fn(),
- getOverallBuckets: jest.fn(),
- getRecords: jest.fn(),
- getTrainedModels: jest.fn(),
- getTrainedModelsStats: jest.fn(),
- info: jest.fn(),
- openJob: jest.fn(),
- postCalendarEvents: jest.fn(),
- postData: jest.fn(),
- previewDatafeed: jest.fn(),
- putCalendar: jest.fn(),
- putCalendarJob: jest.fn(),
- putDataFrameAnalytics: jest.fn(),
- putDatafeed: jest.fn(),
- putFilter: jest.fn(),
- putJob: jest.fn(),
- putTrainedModel: jest.fn(),
- revertModelSnapshot: jest.fn(),
- setUpgradeMode: jest.fn(),
- startDataFrameAnalytics: jest.fn(),
- startDatafeed: jest.fn(),
- stopDataFrameAnalytics: jest.fn(),
- stopDatafeed: jest.fn(),
- updateDatafeed: jest.fn(),
- updateFilter: jest.fn(),
- updateJob: jest.fn(),
- updateModelSnapshot: jest.fn(),
- validate: jest.fn(),
- validateDetector: jest.fn(),
- },
- monitoring: {
- bulk: jest.fn(),
- },
- msearch: jest.fn(),
- msearchTemplate: jest.fn(),
- mtermvectors: jest.fn(),
- nodes: {
- hotThreads: jest.fn(),
- info: jest.fn(),
- reloadSecureSettings: jest.fn(),
- stats: jest.fn(),
- usage: jest.fn(),
- },
- ping: jest.fn(),
- putScript: jest.fn(),
- rankEval: jest.fn(),
- reindex: jest.fn(),
- reindexRethrottle: jest.fn(),
- renderSearchTemplate: jest.fn(),
- rollup: {
- deleteJob: jest.fn(),
- getJobs: jest.fn(),
- getRollupCaps: jest.fn(),
- getRollupIndexCaps: jest.fn(),
- putJob: jest.fn(),
- rollupSearch: jest.fn(),
- startJob: jest.fn(),
- stopJob: jest.fn(),
- },
- scriptsPainlessExecute: jest.fn(),
- scroll: jest.fn(),
- search: jest.fn(),
- searchShards: jest.fn(),
- searchTemplate: jest.fn(),
- searchableSnapshots: {
- clearCache: jest.fn(),
- mount: jest.fn(),
- repositoryStats: jest.fn(),
- stats: jest.fn(),
- },
- security: {
- authenticate: jest.fn(),
- changePassword: jest.fn(),
- clearCachedRealms: jest.fn(),
- clearCachedRoles: jest.fn(),
- createApiKey: jest.fn(),
- deletePrivileges: jest.fn(),
- deleteRole: jest.fn(),
- deleteRoleMapping: jest.fn(),
- deleteUser: jest.fn(),
- disableUser: jest.fn(),
- enableUser: jest.fn(),
- getApiKey: jest.fn(),
- getBuiltinPrivileges: jest.fn(),
- getPrivileges: jest.fn(),
- getRole: jest.fn(),
- getRoleMapping: jest.fn(),
- getToken: jest.fn(),
- getUser: jest.fn(),
- getUserPrivileges: jest.fn(),
- hasPrivileges: jest.fn(),
- invalidateApiKey: jest.fn(),
- invalidateToken: jest.fn(),
- putPrivileges: jest.fn(),
- putRole: jest.fn(),
- putRoleMapping: jest.fn(),
- putUser: jest.fn(),
- },
- slm: {
- deleteLifecycle: jest.fn(),
- executeLifecycle: jest.fn(),
- executeRetention: jest.fn(),
- getLifecycle: jest.fn(),
- getStats: jest.fn(),
- getStatus: jest.fn(),
- putLifecycle: jest.fn(),
- start: jest.fn(),
- stop: jest.fn(),
- },
- snapshot: {
- cleanupRepository: jest.fn(),
- create: jest.fn(),
- createRepository: jest.fn(),
- delete: jest.fn(),
- deleteRepository: jest.fn(),
- get: jest.fn(),
- getRepository: jest.fn(),
- restore: jest.fn(),
- status: jest.fn(),
- verifyRepository: jest.fn(),
- },
- sql: {
- clearCursor: jest.fn(),
- query: jest.fn(),
- translate: jest.fn(),
- },
- ssl: {
- certificates: jest.fn(),
- },
- tasks: {
- cancel: jest.fn(),
- get: jest.fn(),
- list: jest.fn(),
- },
- termvectors: jest.fn(),
- transform: {
- deleteTransform: jest.fn(),
- getTransform: jest.fn(),
- getTransformStats: jest.fn(),
- previewTransform: jest.fn(),
- putTransform: jest.fn(),
- startTransform: jest.fn(),
- stopTransform: jest.fn(),
- updateTransform: jest.fn(),
- },
- update: jest.fn(),
- updateByQuery: jest.fn(),
- updateByQueryRethrottle: jest.fn(),
- watcher: {
- ackWatch: jest.fn(),
- activateWatch: jest.fn(),
- deactivateWatch: jest.fn(),
- deleteWatch: jest.fn(),
- executeWatch: jest.fn(),
- getWatch: jest.fn(),
- putWatch: jest.fn(),
- start: jest.fn(),
- stats: jest.fn(),
- stop: jest.fn(),
- },
- xpack: {
- info: jest.fn(),
- usage: jest.fn(),
- },
- /* /GENERATED */
- };
-
- return mock;
-};
-
-export const clientFacadeMock = {
- create: createFacadeMock,
-};
diff --git a/src/core/server/elasticsearch/client/client_facade.ts b/src/core/server/elasticsearch/client/client_facade.ts
deleted file mode 100644
index 0e7b12337853c8d..000000000000000
--- a/src/core/server/elasticsearch/client/client_facade.ts
+++ /dev/null
@@ -1,1858 +0,0 @@
-/*
- * Licensed to Elasticsearch B.V. under one or more contributor
- * license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright
- * ownership. Elasticsearch B.V. licenses this file to you under
- * the Apache License, Version 2.0 (the "License"); you may
- * not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-import { ApiResponse } from '@elastic/elasticsearch';
-import {
- RequestBody,
- RequestNDBody,
- TransportRequestOptions,
- TransportRequestParams,
- TransportRequestPromise,
-} from '@elastic/elasticsearch/lib/Transport';
-import * as RequestParams from '@elastic/elasticsearch/api/requestParams';
-
-/**
- * Facade used to query the elasticsearch cluster.
- *
- * @public
- */
-export interface ClientFacade {
- transport: {
- request(
- params: TransportRequestParams,
- options?: TransportRequestOptions
- ): Promise;
- };
- /* GENERATED */
- asyncSearch: {
- delete, TContext = unknown>(
- params?: RequestParams.AsyncSearchDelete,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- get, TContext = unknown>(
- params?: RequestParams.AsyncSearchGet,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- submit<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.AsyncSearchSubmit,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- autoscaling: {
- deleteAutoscalingPolicy, TContext = unknown>(
- params?: RequestParams.AutoscalingDeleteAutoscalingPolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getAutoscalingDecision, TContext = unknown>(
- params?: RequestParams.AutoscalingGetAutoscalingDecision,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getAutoscalingPolicy, TContext = unknown>(
- params?: RequestParams.AutoscalingGetAutoscalingPolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- putAutoscalingPolicy<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.AutoscalingPutAutoscalingPolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- bulk<
- TResponse = Record,
- TRequestBody extends RequestNDBody = Array>,
- TContext = unknown
- >(
- params?: RequestParams.Bulk,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- cat: {
- aliases, TContext = unknown>(
- params?: RequestParams.CatAliases,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- allocation, TContext = unknown>(
- params?: RequestParams.CatAllocation,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- count, TContext = unknown>(
- params?: RequestParams.CatCount,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- fielddata, TContext = unknown>(
- params?: RequestParams.CatFielddata,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- health, TContext = unknown>(
- params?: RequestParams.CatHealth,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- help, TContext = unknown>(
- params?: RequestParams.CatHelp,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- indices, TContext = unknown>(
- params?: RequestParams.CatIndices,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- master, TContext = unknown>(
- params?: RequestParams.CatMaster,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- mlDataFrameAnalytics, TContext = unknown>(
- params?: RequestParams.CatMlDataFrameAnalytics,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- mlDatafeeds, TContext = unknown>(
- params?: RequestParams.CatMlDatafeeds,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- mlJobs, TContext = unknown>(
- params?: RequestParams.CatMlJobs,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- mlTrainedModels, TContext = unknown>(
- params?: RequestParams.CatMlTrainedModels,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- nodeattrs, TContext = unknown>(
- params?: RequestParams.CatNodeattrs,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- nodes, TContext = unknown>(
- params?: RequestParams.CatNodes,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- pendingTasks, TContext = unknown>(
- params?: RequestParams.CatPendingTasks,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- plugins, TContext = unknown>(
- params?: RequestParams.CatPlugins,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- recovery, TContext = unknown>(
- params?: RequestParams.CatRecovery,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- repositories, TContext = unknown>(
- params?: RequestParams.CatRepositories,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- segments, TContext = unknown>(
- params?: RequestParams.CatSegments,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- shards, TContext = unknown>(
- params?: RequestParams.CatShards,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- snapshots, TContext = unknown>(
- params?: RequestParams.CatSnapshots,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- tasks, TContext = unknown>(
- params?: RequestParams.CatTasks,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- templates, TContext = unknown>(
- params?: RequestParams.CatTemplates,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- threadPool, TContext = unknown>(
- params?: RequestParams.CatThreadPool,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- transforms, TContext = unknown>(
- params?: RequestParams.CatTransforms,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- ccr: {
- deleteAutoFollowPattern, TContext = unknown>(
- params?: RequestParams.CcrDeleteAutoFollowPattern,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- follow<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.CcrFollow,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- followInfo, TContext = unknown>(
- params?: RequestParams.CcrFollowInfo,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- followStats, TContext = unknown>(
- params?: RequestParams.CcrFollowStats,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- forgetFollower<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.CcrForgetFollower,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getAutoFollowPattern, TContext = unknown>(
- params?: RequestParams.CcrGetAutoFollowPattern,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- pauseAutoFollowPattern, TContext = unknown>(
- params?: RequestParams.CcrPauseAutoFollowPattern,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- pauseFollow, TContext = unknown>(
- params?: RequestParams.CcrPauseFollow,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- putAutoFollowPattern<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.CcrPutAutoFollowPattern,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- resumeAutoFollowPattern, TContext = unknown>(
- params?: RequestParams.CcrResumeAutoFollowPattern,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- resumeFollow<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.CcrResumeFollow,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- stats, TContext = unknown>(
- params?: RequestParams.CcrStats,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- unfollow, TContext = unknown>(
- params?: RequestParams.CcrUnfollow,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- clearScroll<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.ClearScroll,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- cluster: {
- allocationExplain<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.ClusterAllocationExplain,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- deleteComponentTemplate, TContext = unknown>(
- params?: RequestParams.ClusterDeleteComponentTemplate,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- deleteVotingConfigExclusions, TContext = unknown>(
- params?: RequestParams.ClusterDeleteVotingConfigExclusions,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- existsComponentTemplate, TContext = unknown>(
- params?: RequestParams.ClusterExistsComponentTemplate,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getComponentTemplate, TContext = unknown>(
- params?: RequestParams.ClusterGetComponentTemplate,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getSettings, TContext = unknown>(
- params?: RequestParams.ClusterGetSettings,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- health, TContext = unknown>(
- params?: RequestParams.ClusterHealth,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- pendingTasks, TContext = unknown>(
- params?: RequestParams.ClusterPendingTasks,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- postVotingConfigExclusions, TContext = unknown>(
- params?: RequestParams.ClusterPostVotingConfigExclusions,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- putComponentTemplate<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.ClusterPutComponentTemplate,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- putSettings<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.ClusterPutSettings,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- remoteInfo, TContext = unknown>(
- params?: RequestParams.ClusterRemoteInfo,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- reroute<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.ClusterReroute,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- state, TContext = unknown>(
- params?: RequestParams.ClusterState,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- stats, TContext = unknown>(
- params?: RequestParams.ClusterStats,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- count<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.Count,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- create<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.Create,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- delete, TContext = unknown>(
- params?: RequestParams.Delete,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- deleteByQuery<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.DeleteByQuery,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- deleteByQueryRethrottle, TContext = unknown>(
- params?: RequestParams.DeleteByQueryRethrottle,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- deleteScript, TContext = unknown>(
- params?: RequestParams.DeleteScript,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- enrich: {
- deletePolicy, TContext = unknown>(
- params?: RequestParams.EnrichDeletePolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- executePolicy, TContext = unknown>(
- params?: RequestParams.EnrichExecutePolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getPolicy, TContext = unknown>(
- params?: RequestParams.EnrichGetPolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- putPolicy<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.EnrichPutPolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- stats, TContext = unknown>(
- params?: RequestParams.EnrichStats,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- eql: {
- search<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.EqlSearch,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- exists, TContext = unknown>(
- params?: RequestParams.Exists,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- existsSource, TContext = unknown>(
- params?: RequestParams.ExistsSource,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- explain<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.Explain,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- fieldCaps, TContext = unknown>(
- params?: RequestParams.FieldCaps,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- get, TContext = unknown>(
- params?: RequestParams.Get,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getScript, TContext = unknown>(
- params?: RequestParams.GetScript,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getScriptContext, TContext = unknown>(
- params?: RequestParams.GetScriptContext,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getScriptLanguages, TContext = unknown>(
- params?: RequestParams.GetScriptLanguages,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getSource, TContext = unknown>(
- params?: RequestParams.GetSource,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- graph: {
- explore<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.GraphExplore,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- ilm: {
- deleteLifecycle, TContext = unknown>(
- params?: RequestParams.IlmDeleteLifecycle,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- explainLifecycle, TContext = unknown>(
- params?: RequestParams.IlmExplainLifecycle,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getLifecycle, TContext = unknown>(
- params?: RequestParams.IlmGetLifecycle,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- getStatus, TContext = unknown>(
- params?: RequestParams.IlmGetStatus,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- moveToStep<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.IlmMoveToStep,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- putLifecycle<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.IlmPutLifecycle,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- removePolicy, TContext = unknown>(
- params?: RequestParams.IlmRemovePolicy,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- retry, TContext = unknown>(
- params?: RequestParams.IlmRetry,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- start, TContext = unknown>(
- params?: RequestParams.IlmStart,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- stop, TContext = unknown>(
- params?: RequestParams.IlmStop,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- };
- index<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.Index,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- indices: {
- analyze<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.IndicesAnalyze,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- clearCache, TContext = unknown>(
- params?: RequestParams.IndicesClearCache,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- clone<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.IndicesClone,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- close, TContext = unknown>(
- params?: RequestParams.IndicesClose,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- create<
- TResponse = Record,
- TRequestBody extends RequestBody = Record,
- TContext = unknown
- >(
- params?: RequestParams.IndicesCreate,
- options?: TransportRequestOptions
- ): TransportRequestPromise>;
- createDataStream<
- TResponse = Record