feat(clients): add optionnal scopes to replaceAllObjects [skip-bc] (#4296) (generated) [skip ci]

Co-authored-by: Pierre Millot <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-go/algolia/search/api_search.go

@@ -6835,7 +6835,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
    * @throws AlgoliaRuntimeException When an error occurred during the serialization
    */
   public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterable<T> objects, int batchSize) {
-    return replaceAllObjects(indexName, objects, batchSize, null);
+    return replaceAllObjects(indexName, objects, batchSize, null, null);
   }
 
   /**
@@ -6848,6 +6848,28 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
    * @param objects The array of `objects` to store in the given Algolia `indexName`.
    * @param batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal
    *     to `length(objects) / batchSize`.
+   * @param scopes The `scopes` to keep from the index. Defaults to ['settings', 'rules',
+   *     'synonyms'].
+   * @throws AlgoliaRetryException When the retry has failed on all hosts
+   * @throws AlgoliaApiException When the API sends an http error code
+   * @throws AlgoliaRuntimeException When an error occurred during the serialization
+   */
+  public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterable<T> objects, int batchSize, List<ScopeType> scopes) {
+    return replaceAllObjects(indexName, objects, batchSize, scopes, null);
+  }
+
+  /**
+   * Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
+   * untouched. Replace all records in an index without any downtime. See
+   * https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
+   * details.
+   *
+   * @param indexName The `indexName` to replace `objects` in.
+   * @param objects The array of `objects` to store in the given Algolia `indexName`.
+   * @param batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal
+   *     to `length(objects) / batchSize`.
+   * @param scopes The `scopes` to keep from the index. Defaults to ['settings', 'rules',
+   *     'synonyms'].
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions. (optional)
    * @throws AlgoliaRetryException When the retry has failed on all hosts
@@ -6858,6 +6880,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(
     String indexName,
     Iterable<T> objects,
     int batchSize,
+    List<ScopeType> scopes,
     RequestOptions requestOptions
   ) {
     Random rnd = new Random();
@@ -6867,16 +6890,21 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(
       batchSize = 1000;
     }
 
+    if (scopes == null) {
+      scopes = new ArrayList<ScopeType>() {
+        {
+          add(ScopeType.SETTINGS);
+          add(ScopeType.RULES);
+          add(ScopeType.SYNONYMS);
+        }
+      };
+    }
+
     try {
       // Copy settings, synonyms and rules
       UpdatedAtResponse copyOperationResponse = operationIndex(
         indexName,
-        new OperationIndexParams()
-          .setOperation(OperationType.COPY)
-          .setDestination(tmpIndexName)
-          .addScope(ScopeType.SETTINGS)
-          .addScope(ScopeType.RULES)
-          .addScope(ScopeType.SYNONYMS),
+        new OperationIndexParams().setOperation(OperationType.COPY).setDestination(tmpIndexName).setScope(scopes),
         requestOptions
       );
 
@@ -6887,12 +6915,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(
 
       copyOperationResponse = operationIndex(
         indexName,
-        new OperationIndexParams()
-          .setOperation(OperationType.COPY)
-          .setDestination(tmpIndexName)
-          .addScope(ScopeType.SETTINGS)
-          .addScope(ScopeType.RULES)
-          .addScope(ScopeType.SYNONYMS),
+        new OperationIndexParams().setOperation(OperationType.COPY).setDestination(tmpIndexName).setScope(scopes),
         requestOptions
       );
       waitForTask(tmpIndexName, copyOperationResponse.getTaskID(), requestOptions);

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java

@@ -23,6 +23,7 @@ import type { OperationIndexParams } from '../model/operationIndexParams';
 
 import type { Rule } from '../model/rule';
 
+import type { ScopeType } from '../model/scopeType';
 import type { SearchDictionaryEntriesParams } from '../model/searchDictionaryEntriesParams';
 
 import type { SearchForFacetValuesRequest } from '../model/searchForFacetValuesRequest';
@@ -870,4 +871,9 @@ export type ReplaceAllObjectsOptions = {
    * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
    */
   batchSize?: number;
+
+  /**
+   * The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+   */
+  scopes?: Array<ScopeType>;
 };

clients/algoliasearch-client-javascript/packages/client-search/model/clientMethodProps.ts

@@ -633,23 +633,28 @@ export function createSearchClient({
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+     * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
     async replaceAllObjects(
-      { indexName, objects, batchSize }: ReplaceAllObjectsOptions,
+      { indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions,
       requestOptions?: RequestOptions,
     ): Promise<ReplaceAllObjectsResponse> {
       const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
 
+      if (scopes === undefined) {
+        scopes = ['settings', 'rules', 'synonyms'];
+      }
+
       try {
         let copyOperationResponse = await this.operationIndex(
           {
             indexName,
             operationIndexParams: {
               operation: 'copy',
               destination: tmpIndexName,
-              scope: ['settings', 'rules', 'synonyms'],
+              scope: scopes,
             },
           },
           requestOptions,
@@ -671,7 +676,7 @@ export function createSearchClient({
             operationIndexParams: {
               operation: 'copy',
               destination: tmpIndexName,
-              scope: ['settings', 'rules', 'synonyms'],
+              scope: scopes,
             },
           },
           requestOptions,