feat(specs): add watch to pushTask ingestion (#4224) (generated) [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs

@@ -1275,13 +1275,14 @@ public interface IIngestionClient
   ///   - editSettings
   /// <param name="taskID">Unique identifier of a task.</param>
   /// <param name="pushTaskPayload">Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.</param>
+  /// <param name="watch">When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. (optional)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
   /// <returns>Task of RunResponse</returns>
-  Task<RunResponse> PushTaskAsync(string taskID, PushTaskPayload pushTaskPayload, RequestOptions options = null, CancellationToken cancellationToken = default);
+  Task<RunResponse> PushTaskAsync(string taskID, PushTaskPayload pushTaskPayload, bool? watch = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
   /// Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints. (Synchronous version)
@@ -1293,13 +1294,14 @@ public interface IIngestionClient
   ///   - editSettings
   /// <param name="taskID">Unique identifier of a task.</param>
   /// <param name="pushTaskPayload">Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.</param>
+  /// <param name="watch">When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. (optional)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
   /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
   /// <returns>RunResponse</returns>
-  RunResponse PushTask(string taskID, PushTaskPayload pushTaskPayload, RequestOptions options = null, CancellationToken cancellationToken = default);
+  RunResponse PushTask(string taskID, PushTaskPayload pushTaskPayload, bool? watch = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
   /// Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
@@ -2802,7 +2804,7 @@ public ListTransformationsResponse ListTransformations(int? itemsPerPage = defau
 
 
   /// <inheritdoc />
-  public async Task<RunResponse> PushTaskAsync(string taskID, PushTaskPayload pushTaskPayload, RequestOptions options = null, CancellationToken cancellationToken = default)
+  public async Task<RunResponse> PushTaskAsync(string taskID, PushTaskPayload pushTaskPayload, bool? watch = default, RequestOptions options = null, CancellationToken cancellationToken = default)
   {
 
     if (taskID == null)
@@ -2816,14 +2818,15 @@ public async Task<RunResponse> PushTaskAsync(string taskID, PushTaskPayload push
 
     requestOptions.PathParameters.Add("taskID", QueryStringHelper.ParameterToString(taskID));
 
+    requestOptions.AddQueryParameter("watch", watch);
     requestOptions.Data = pushTaskPayload;
     return await _transport.ExecuteRequestAsync<RunResponse>(new HttpMethod("POST"), "/2/tasks/{taskID}/push", requestOptions, cancellationToken).ConfigureAwait(false);
   }
 
 
   /// <inheritdoc />
-  public RunResponse PushTask(string taskID, PushTaskPayload pushTaskPayload, RequestOptions options = null, CancellationToken cancellationToken = default) =>
-    AsyncHelper.RunSync(() => PushTaskAsync(taskID, pushTaskPayload, options, cancellationToken));
+  public RunResponse PushTask(string taskID, PushTaskPayload pushTaskPayload, bool? watch = default, RequestOptions options = null, CancellationToken cancellationToken = default) =>
+    AsyncHelper.RunSync(() => PushTaskAsync(taskID, pushTaskPayload, watch, options, cancellationToken));
 
 
   /// <inheritdoc />

clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go

@@ -2996,6 +2996,44 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync()
     return this.listTransformationsAsync(null, null, null, null, null);
   }
 
+  /**
+   * Push a `batch` request payload through the Pipeline. You can check the status of task pushes
+   * with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @param pushTaskPayload Request body of a Search API `batch` request that will be pushed in the
+   *     Connectors pipeline. (required)
+   * @param watch When provided, the push operation will be synchronous and the API will wait for
+   *     the ingestion to be finished before responding. (optional)
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions.
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public RunResponse pushTask(
+    @Nonnull String taskID,
+    @Nonnull PushTaskPayload pushTaskPayload,
+    Boolean watch,
+    RequestOptions requestOptions
+  ) throws AlgoliaRuntimeException {
+    return LaunderThrowable.await(pushTaskAsync(taskID, pushTaskPayload, watch, requestOptions));
+  }
+
+  /**
+   * Push a `batch` request payload through the Pipeline. You can check the status of task pushes
+   * with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @param pushTaskPayload Request body of a Search API `batch` request that will be pushed in the
+   *     Connectors pipeline. (required)
+   * @param watch When provided, the push operation will be synchronous and the API will wait for
+   *     the ingestion to be finished before responding. (optional)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public RunResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload pushTaskPayload, Boolean watch)
+    throws AlgoliaRuntimeException {
+    return this.pushTask(taskID, pushTaskPayload, watch, null);
+  }
+
   /**
    * Push a `batch` request payload through the Pipeline. You can check the status of task pushes
    * with the observability endpoints.
@@ -3009,7 +3047,7 @@ public CompletableFuture<ListTransformationsResponse> listTransformationsAsync()
    */
   public RunResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload pushTaskPayload, RequestOptions requestOptions)
     throws AlgoliaRuntimeException {
-    return LaunderThrowable.await(pushTaskAsync(taskID, pushTaskPayload, requestOptions));
+    return this.pushTask(taskID, pushTaskPayload, null, requestOptions);
   }
 
   /**
@@ -3022,7 +3060,7 @@ public RunResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload pus
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public RunResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload pushTaskPayload) throws AlgoliaRuntimeException {
-    return this.pushTask(taskID, pushTaskPayload, null);
+    return this.pushTask(taskID, pushTaskPayload, null, null);
   }
 
   /**
@@ -3032,13 +3070,16 @@ public RunResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload pus
    * @param taskID Unique identifier of a task. (required)
    * @param pushTaskPayload Request body of a Search API `batch` request that will be pushed in the
    *     Connectors pipeline. (required)
+   * @param watch When provided, the push operation will be synchronous and the API will wait for
+   *     the ingestion to be finished before responding. (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<RunResponse> pushTaskAsync(
     @Nonnull String taskID,
     @Nonnull PushTaskPayload pushTaskPayload,
+    Boolean watch,
     RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
     Parameters.requireNonNull(taskID, "Parameter `taskID` is required when calling `pushTask`.");
@@ -3049,10 +3090,46 @@ public CompletableFuture<RunResponse> pushTaskAsync(
       .setPath("/2/tasks/{taskID}/push", taskID)
       .setMethod("POST")
       .setBody(pushTaskPayload)
+      .addQueryParameter("watch", watch)
       .build();
     return executeAsync(request, requestOptions, new TypeReference<RunResponse>() {});
   }
 
+  /**
+   * (asynchronously) Push a `batch` request payload through the Pipeline. You can check the status
+   * of task pushes with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @param pushTaskPayload Request body of a Search API `batch` request that will be pushed in the
+   *     Connectors pipeline. (required)
+   * @param watch When provided, the push operation will be synchronous and the API will wait for
+   *     the ingestion to be finished before responding. (optional)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public CompletableFuture<RunResponse> pushTaskAsync(@Nonnull String taskID, @Nonnull PushTaskPayload pushTaskPayload, Boolean watch)
+    throws AlgoliaRuntimeException {
+    return this.pushTaskAsync(taskID, pushTaskPayload, watch, null);
+  }
+
+  /**
+   * (asynchronously) Push a `batch` request payload through the Pipeline. You can check the status
+   * of task pushes with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @param pushTaskPayload Request body of a Search API `batch` request that will be pushed in the
+   *     Connectors pipeline. (required)
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions.
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public CompletableFuture<RunResponse> pushTaskAsync(
+    @Nonnull String taskID,
+    @Nonnull PushTaskPayload pushTaskPayload,
+    RequestOptions requestOptions
+  ) throws AlgoliaRuntimeException {
+    return this.pushTaskAsync(taskID, pushTaskPayload, null, requestOptions);
+  }
+
   /**
    * (asynchronously) Push a `batch` request payload through the Pipeline. You can check the status
    * of task pushes with the observability endpoints.
@@ -3064,7 +3141,7 @@ public CompletableFuture<RunResponse> pushTaskAsync(
    */
   public CompletableFuture<RunResponse> pushTaskAsync(@Nonnull String taskID, @Nonnull PushTaskPayload pushTaskPayload)
     throws AlgoliaRuntimeException {
-    return this.pushTaskAsync(taskID, pushTaskPayload, null);
+    return this.pushTaskAsync(taskID, pushTaskPayload, null, null);
   }
 
   /**

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

@@ -588,6 +588,10 @@ export type PushTaskProps = {
    * Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
    */
   pushTaskPayload: PushTaskPayload;
+  /**
+   * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+   */
+  watch?: boolean;
 };
 
 /**

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

@@ -1691,9 +1691,10 @@ export function createIngestionClient({
      * @param pushTask - The pushTask object.
      * @param pushTask.taskID - Unique identifier of a task.
      * @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
+     * @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse> {
+    pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse> {
       if (!taskID) {
         throw new Error('Parameter `taskID` is required when calling `pushTask`.');
       }
@@ -1713,6 +1714,10 @@ export function createIngestionClient({
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
 
+      if (watch !== undefined) {
+        queryParameters['watch'] = watch.toString();
+      }
+
       const request: Request = {
         method: 'POST',
         path: requestPath,

clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts

@@ -922,13 +922,17 @@ public class IngestionClient(
    *   - editSettings
    * @param taskID Unique identifier of a task.
    * @param pushTaskPayload Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
+   * @param watch When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
    * @param requestOptions additional request configuration.
    */
-  public suspend fun pushTask(taskID: String, pushTaskPayload: PushTaskPayload, requestOptions: RequestOptions? = null): RunResponse {
+  public suspend fun pushTask(taskID: String, pushTaskPayload: PushTaskPayload, watch: Boolean? = null, requestOptions: RequestOptions? = null): RunResponse {
     require(taskID.isNotBlank()) { "Parameter `taskID` is required when calling `pushTask`." }
     val requestConfig = RequestConfig(
       method = RequestMethod.POST,
       path = listOf("2", "tasks", "$taskID", "push"),
+      query = buildMap {
+        watch?.let { put("watch", it) }
+      },
       body = pushTaskPayload,
     )
     return requester.execute(

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt

@@ -1756,11 +1756,12 @@ public function listTransformations($itemsPerPage = null, $page = null, $sort =
      *
      * @see PushTaskPayload
      *
+     * @param bool  $watch          When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. (optional)
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
      * @return \Algolia\AlgoliaSearch\Model\Ingestion\RunResponse|array<string, mixed>
      */
-    public function pushTask($taskID, $pushTaskPayload, $requestOptions = [])
+    public function pushTask($taskID, $pushTaskPayload, $watch = null, $requestOptions = [])
     {
         // verify the required parameter 'taskID' is set
         if (!isset($taskID)) {
@@ -1780,6 +1781,10 @@ public function pushTask($taskID, $pushTaskPayload, $requestOptions = [])
         $headers = [];
         $httpBody = $pushTaskPayload;
 
+        if (null !== $watch) {
+            $queryParameters['watch'] = $watch;
+        }
+
         // path params
         if (null !== $taskID) {
             $resourcePath = str_replace(