Add refresh option to SavedObjectsImporter (#131339)

docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.import.md

@@ -9,14 +9,14 @@ Import saved objects from given stream. See the [options](./kibana-plugin-core-s
 <b>Signature:</b>
 
 ```typescript
-import({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse>;
+import({ readStream, createNewCopies, namespace, overwrite, refresh, }: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { readStream, createNewCopies, namespace, overwrite, } | SavedObjectsImportOptions |  |
+|  { readStream, createNewCopies, namespace, overwrite, refresh, } | SavedObjectsImportOptions |  |
 
 <b>Returns:</b>
 

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

@@ -21,6 +21,6 @@ export declare class SavedObjectsImporter
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [import({ readStream, createNewCopies, namespace, overwrite, })](./kibana-plugin-core-server.savedobjectsimporter.import.md) |  | Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. |
+|  [import({ readStream, createNewCopies, namespace, overwrite, refresh, })](./kibana-plugin-core-server.savedobjectsimporter.import.md) |  | Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. |
 |  [resolveImportErrors({ readStream, createNewCopies, namespace, retries, })](./kibana-plugin-core-server.savedobjectsimporter.resolveimporterrors.md) |  | Resolve and return saved object import errors. See the [options](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) for more detailed information. |
 

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

@@ -20,4 +20,5 @@ export interface SavedObjectsImportOptions
 |  [namespace?](./kibana-plugin-core-server.savedobjectsimportoptions.namespace.md) | string | <i>(Optional)</i> if specified, will import in given namespace, else will import as global object |
 |  [overwrite](./kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md) | boolean | If true, will override existing object if present. Note: this has no effect when used with the <code>createNewCopies</code> option. |
 |  [readStream](./kibana-plugin-core-server.savedobjectsimportoptions.readstream.md) | Readable | The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to import |
+|  [refresh?](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md) | boolean \| 'wait\_for' | <i>(Optional)</i> Refresh setting, defaults to <code>wait_for</code> |
 

docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md

@@ -0,0 +1,13 @@
+<!-- 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; [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) &gt; [refresh](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md)
+
+## SavedObjectsImportOptions.refresh property
+
+Refresh setting, defaults to `wait_for`
+
+<b>Signature:</b>
+
+```typescript
+refresh?: boolean | 'wait_for';
+```

src/core/server/saved_objects/import/import_saved_objects.ts

@@ -35,6 +35,8 @@ export interface ImportSavedObjectsOptions {
   objectLimit: number;
   /** If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option. */
   overwrite: boolean;
+  /** Refresh setting, defaults to `wait_for` */
+  refresh?: boolean | 'wait_for';
   /** {@link SavedObjectsClientContract | client} to use to perform the import operation */
   savedObjectsClient: SavedObjectsClientContract;
   /** The registry of all known saved object types */
@@ -62,6 +64,7 @@ export async function importSavedObjectsFromStream({
   typeRegistry,
   importHooks,
   namespace,
+  refresh,
 }: ImportSavedObjectsOptions): Promise<SavedObjectsImportResponse> {
   let errorAccumulator: SavedObjectsImportFailure[] = [];
   const supportedTypes = typeRegistry.getImportableAndExportableTypes().map((type) => type.name);
@@ -141,6 +144,7 @@ export async function importSavedObjectsFromStream({
     importStateMap,
     overwrite,
     namespace,
+    refresh,
   };
   const createSavedObjectsResult = await createSavedObjects(createSavedObjectsParams);
   errorAccumulator = [...errorAccumulator, ...createSavedObjectsResult.errors];

src/core/server/saved_objects/import/lib/create_saved_objects.ts

@@ -18,6 +18,7 @@ export interface CreateSavedObjectsParams<T> {
   importStateMap: ImportStateMap;
   namespace?: string;
   overwrite?: boolean;
+  refresh?: boolean | 'wait_for';
 }
 export interface CreateSavedObjectsResult<T> {
   createdObjects: Array<CreatedObject<T>>;
@@ -35,6 +36,7 @@ export const createSavedObjects = async <T>({
   importStateMap,
   namespace,
   overwrite,
+  refresh,
 }: CreateSavedObjectsParams<T>): Promise<CreateSavedObjectsResult<T>> => {
   // filter out any objects that resulted in errors
   const errorSet = accumulatedErrors.reduce(
@@ -87,6 +89,7 @@ export const createSavedObjects = async <T>({
     const bulkCreateResponse = await savedObjectsClient.bulkCreate(objectsToCreate, {
       namespace,
       overwrite,
+      refresh,
     });
     expectedResults = bulkCreateResponse.saved_objects;
   }

src/core/server/saved_objects/import/saved_objects_importer.ts

@@ -66,12 +66,14 @@ export class SavedObjectsImporter {
     createNewCopies,
     namespace,
     overwrite,
+    refresh,
   }: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse> {
     return importSavedObjectsFromStream({
       readStream,
       createNewCopies,
       namespace,
       overwrite,
+      refresh,
       objectLimit: this.#importSizeLimit,
       savedObjectsClient: this.#savedObjectsClient,
       typeRegistry: this.#typeRegistry,

src/core/server/saved_objects/import/types.ts

@@ -155,6 +155,8 @@ export interface SavedObjectsImportOptions {
   namespace?: string;
   /** If true, will create new copies of import objects, each with a random `id` and undefined `originId`. */
   createNewCopies: boolean;
+  /** Refresh setting, defaults to `wait_for` */
+  refresh?: boolean | 'wait_for';
 }
 
 /**

src/core/server/server.api.md

@@ -2541,7 +2541,7 @@ export class SavedObjectsImporter {
         typeRegistry: ISavedObjectTypeRegistry;
         importSizeLimit: number;
     });
-    import({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse>;
+    import({ readStream, createNewCopies, namespace, overwrite, refresh, }: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse>;
     resolveImportErrors({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions): Promise<SavedObjectsImportResponse>;
 }
 
@@ -2604,6 +2604,7 @@ export interface SavedObjectsImportOptions {
     namespace?: string;
     overwrite: boolean;
     readStream: Readable;
+    refresh?: boolean | 'wait_for';
 }
 
 // @public