Skip to content

Commit

Permalink
Add multiple namespaces support to PIT search and finder (#109062) (#…
Browse files Browse the repository at this point in the history
…109603)

* initial modifications

* change approach for openPointInTime and add tests for spaces wrapper changes

* fix and add security wrapper tests

* fix export security FTR tests

* update generated doc

* add tests for PIT finder

* NIT

* improve doc

* nits

Co-authored-by: Pierre Gayvallet <pierre.gayvallet@gmail.com>
  • Loading branch information
kibanamachine and pgayvallet authored Aug 23, 2021
1 parent 171f655 commit d17d2e7
Show file tree
Hide file tree
Showing 13 changed files with 384 additions and 185 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@
<b>Signature:</b>

```typescript
export interface SavedObjectsOpenPointInTimeOptions extends SavedObjectsBaseOptions
export interface SavedObjectsOpenPointInTimeOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [keepAlive](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md) | <code>string</code> | Optionally specify how long ES should keep the PIT alive until the next request. Defaults to <code>5m</code>. |
| [namespaces](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md) | <code>string[]</code> | An optional list of namespaces to be used when opening the PIT.<!-- -->When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - <code>['*']</code> will search across all available spaces |
| [preference](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md) | <code>string</code> | An optional ES preference value to be used for the query. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsOpenPointInTimeOptions](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md) &gt; [namespaces](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md)

## SavedObjectsOpenPointInTimeOptions.namespaces property

An optional list of namespaces to be used when opening the PIT.

When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - `['*']` will search across all available spaces

<b>Signature:</b>

```typescript
namespaces?: string[];
```
Loading

0 comments on commit d17d2e7

Please sign in to comment.