feat(specs): document runMetadata parameter (generated)

algolia/api-clients-automation#5087

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Devin Beeuwkes <[email protected]>

Author: algolia-bot

algoliasearch/src/main/java/com/algolia/api/IngestionClient.java

@@ -3641,6 +3641,31 @@ public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull String sourc
     return this.runSourceAsync(sourceID, null, null);
   }
 
+  /**
+   * Runs a task. You can check the status of task runs with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (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 runTask(@Nonnull String taskID, RunTaskPayload runTaskPayload, @Nullable RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
+    return LaunderThrowable.await(runTaskAsync(taskID, runTaskPayload, requestOptions));
+  }
+
+  /**
+   * Runs a task. You can check the status of task runs with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (optional)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public RunResponse runTask(@Nonnull String taskID, RunTaskPayload runTaskPayload) throws AlgoliaRuntimeException {
+    return this.runTask(taskID, runTaskPayload, null);
+  }
+
   /**
    * Runs a task. You can check the status of task runs with the observability endpoints.
    *
@@ -3650,7 +3675,7 @@ public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull String sourc
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public RunResponse runTask(@Nonnull String taskID, @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
-    return LaunderThrowable.await(runTaskAsync(taskID, requestOptions));
+    return this.runTask(taskID, null, requestOptions);
   }
 
   /**
@@ -3660,27 +3685,56 @@ public RunResponse runTask(@Nonnull String taskID, @Nullable RequestOptions requ
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public RunResponse runTask(@Nonnull String taskID) throws AlgoliaRuntimeException {
-    return this.runTask(taskID, null);
+    return this.runTask(taskID, null, null);
   }
 
   /**
    * (asynchronously) Runs a task. You can check the status of task runs with the observability
    * endpoints.
    *
    * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (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> runTaskAsync(@Nonnull String taskID, @Nullable RequestOptions requestOptions)
-    throws AlgoliaRuntimeException {
+  public CompletableFuture<RunResponse> runTaskAsync(
+    @Nonnull String taskID,
+    RunTaskPayload runTaskPayload,
+    @Nullable RequestOptions requestOptions
+  ) throws AlgoliaRuntimeException {
     Parameters.requireNonNull(taskID, "Parameter `taskID` is required when calling `runTask`.");
 
-    HttpRequest request = HttpRequest.builder().setPath("/2/tasks/{taskID}/run", taskID).setMethod("POST").build();
-
+    HttpRequest request = HttpRequest.builder().setPath("/2/tasks/{taskID}/run", taskID).setMethod("POST").setBody(runTaskPayload).build();
     return executeAsync(request, requestOptions, new TypeReference<RunResponse>() {});
   }
 
+  /**
+   * (asynchronously) Runs a task. You can check the status of task runs with the observability
+   * endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (optional)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public CompletableFuture<RunResponse> runTaskAsync(@Nonnull String taskID, RunTaskPayload runTaskPayload) throws AlgoliaRuntimeException {
+    return this.runTaskAsync(taskID, runTaskPayload, null);
+  }
+
+  /**
+   * (asynchronously) Runs a task. You can check the status of task runs with the observability
+   * endpoints.
+   *
+   * @param taskID Unique identifier of a task. (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> runTaskAsync(@Nonnull String taskID, @Nullable RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
+    return this.runTaskAsync(taskID, null, requestOptions);
+  }
+
   /**
    * (asynchronously) Runs a task. You can check the status of task runs with the observability
    * endpoints.
@@ -3689,54 +3743,84 @@ public CompletableFuture<RunResponse> runTaskAsync(@Nonnull String taskID, @Null
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<RunResponse> runTaskAsync(@Nonnull String taskID) throws AlgoliaRuntimeException {
-    return this.runTaskAsync(taskID, null);
+    return this.runTaskAsync(taskID, null, null);
   }
 
   /**
    * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of
    * task runs with the observability endpoints.
    *
    * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (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
    * @deprecated
    */
   @Deprecated
-  public RunResponse runTaskV1(@Nonnull String taskID, @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
-    return LaunderThrowable.await(runTaskV1Async(taskID, requestOptions));
+  public RunResponse runTaskV1(@Nonnull String taskID, RunTaskPayload runTaskPayload, @Nullable RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
+    return LaunderThrowable.await(runTaskV1Async(taskID, runTaskPayload, requestOptions));
   }
 
   /**
    * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of
    * task runs with the observability endpoints.
    *
    * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    * @deprecated
    */
   @Deprecated
+  public RunResponse runTaskV1(@Nonnull String taskID, RunTaskPayload runTaskPayload) throws AlgoliaRuntimeException {
+    return this.runTaskV1(taskID, runTaskPayload, null);
+  }
+
+  /**
+   * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of
+   * task runs with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (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 RunResponse runTaskV1(@Nonnull String taskID, @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
+    return this.runTaskV1(taskID, null, requestOptions);
+  }
+
+  /**
+   * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of
+   * task runs with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
   public RunResponse runTaskV1(@Nonnull String taskID) throws AlgoliaRuntimeException {
-    return this.runTaskV1(taskID, null);
+    return this.runTaskV1(taskID, null, null);
   }
 
   /**
    * (asynchronously) Runs a task using the v1 endpoint, please use `runTask` instead. You can check
    * the status of task runs with the observability endpoints.
    *
    * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (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
    * @deprecated
    */
   @Deprecated
-  public CompletableFuture<RunResponse> runTaskV1Async(@Nonnull String taskID, @Nullable RequestOptions requestOptions)
-    throws AlgoliaRuntimeException {
+  public CompletableFuture<RunResponse> runTaskV1Async(
+    @Nonnull String taskID,
+    RunTaskPayload runTaskPayload,
+    @Nullable RequestOptions requestOptions
+  ) throws AlgoliaRuntimeException {
     Parameters.requireNonNull(taskID, "Parameter `taskID` is required when calling `runTaskV1`.");
 
-    HttpRequest request = HttpRequest.builder().setPath("/1/tasks/{taskID}/run", taskID).setMethod("POST").build();
-
+    HttpRequest request = HttpRequest.builder().setPath("/1/tasks/{taskID}/run", taskID).setMethod("POST").setBody(runTaskPayload).build();
     return executeAsync(request, requestOptions, new TypeReference<RunResponse>() {});
   }
 
@@ -3745,12 +3829,39 @@ public CompletableFuture<RunResponse> runTaskV1Async(@Nonnull String taskID, @Nu
    * the status of task runs with the observability endpoints.
    *
    * @param taskID Unique identifier of a task. (required)
+   * @param runTaskPayload (optional)
    * @throws AlgoliaRuntimeException If it fails to process the API call
    * @deprecated
    */
   @Deprecated
+  public CompletableFuture<RunResponse> runTaskV1Async(@Nonnull String taskID, RunTaskPayload runTaskPayload)
+    throws AlgoliaRuntimeException {
+    return this.runTaskV1Async(taskID, runTaskPayload, null);
+  }
+
+  /**
+   * (asynchronously) Runs a task using the v1 endpoint, please use `runTask` instead. You can check
+   * the status of task runs with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (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> runTaskV1Async(@Nonnull String taskID, @Nullable RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
+    return this.runTaskV1Async(taskID, null, requestOptions);
+  }
+
+  /**
+   * (asynchronously) Runs a task using the v1 endpoint, please use `runTask` instead. You can check
+   * the status of task runs with the observability endpoints.
+   *
+   * @param taskID Unique identifier of a task. (required)
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
   public CompletableFuture<RunResponse> runTaskV1Async(@Nonnull String taskID) throws AlgoliaRuntimeException {
-    return this.runTaskV1Async(taskID, null);
+    return this.runTaskV1Async(taskID, null, null);
   }
 
   /**

algoliasearch/src/main/java/com/algolia/model/ingestion/RunSourcePayload.java

@@ -6,7 +6,9 @@
 import com.fasterxml.jackson.annotation.*;
 import com.fasterxml.jackson.databind.annotation.*;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 
 /** RunSourcePayload */
@@ -24,6 +26,9 @@ public class RunSourcePayload {
   @JsonProperty("entityType")
   private EntityType entityType;
 
+  @JsonProperty("runMetadata")
+  private Map<String, Object> runMetadata;
+
   public RunSourcePayload setIndexToInclude(List<String> indexToInclude) {
     this.indexToInclude = indexToInclude;
     return this;
@@ -92,6 +97,25 @@ public EntityType getEntityType() {
     return entityType;
   }
 
+  public RunSourcePayload setRunMetadata(Map<String, Object> runMetadata) {
+    this.runMetadata = runMetadata;
+    return this;
+  }
+
+  public RunSourcePayload putRunMetadata(String key, Object runMetadataItem) {
+    if (this.runMetadata == null) {
+      this.runMetadata = new HashMap<>();
+    }
+    this.runMetadata.put(key, runMetadataItem);
+    return this;
+  }
+
+  /** Additional information that will be passed to the created runs. */
+  @javax.annotation.Nullable
+  public Map<String, Object> getRunMetadata() {
+    return runMetadata;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -105,13 +129,14 @@ public boolean equals(Object o) {
       Objects.equals(this.indexToInclude, runSourcePayload.indexToInclude) &&
       Objects.equals(this.indexToExclude, runSourcePayload.indexToExclude) &&
       Objects.equals(this.entityIDs, runSourcePayload.entityIDs) &&
-      Objects.equals(this.entityType, runSourcePayload.entityType)
+      Objects.equals(this.entityType, runSourcePayload.entityType) &&
+      Objects.equals(this.runMetadata, runSourcePayload.runMetadata)
     );
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(indexToInclude, indexToExclude, entityIDs, entityType);
+    return Objects.hash(indexToInclude, indexToExclude, entityIDs, entityType, runMetadata);
   }
 
   @Override
@@ -122,6 +147,7 @@ public String toString() {
     sb.append("    indexToExclude: ").append(toIndentedString(indexToExclude)).append("\n");
     sb.append("    entityIDs: ").append(toIndentedString(entityIDs)).append("\n");
     sb.append("    entityType: ").append(toIndentedString(entityType)).append("\n");
+    sb.append("    runMetadata: ").append(toIndentedString(runMetadata)).append("\n");
     sb.append("}");
     return sb.toString();
   }

algoliasearch/src/main/java/com/algolia/model/ingestion/RunTaskPayload.java

@@ -0,0 +1,72 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost
+// - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+package com.algolia.model.ingestion;
+
+import com.fasterxml.jackson.annotation.*;
+import com.fasterxml.jackson.databind.annotation.*;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+
+/** RunTaskPayload */
+public class RunTaskPayload {
+
+  @JsonProperty("runMetadata")
+  private Map<String, Object> runMetadata;
+
+  public RunTaskPayload setRunMetadata(Map<String, Object> runMetadata) {
+    this.runMetadata = runMetadata;
+    return this;
+  }
+
+  public RunTaskPayload putRunMetadata(String key, Object runMetadataItem) {
+    if (this.runMetadata == null) {
+      this.runMetadata = new HashMap<>();
+    }
+    this.runMetadata.put(key, runMetadataItem);
+    return this;
+  }
+
+  /** Additional information that will be passed to the created run. */
+  @javax.annotation.Nullable
+  public Map<String, Object> getRunMetadata() {
+    return runMetadata;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    RunTaskPayload runTaskPayload = (RunTaskPayload) o;
+    return Objects.equals(this.runMetadata, runTaskPayload.runMetadata);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(runMetadata);
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("class RunTaskPayload {\n");
+    sb.append("    runMetadata: ").append(toIndentedString(runMetadata)).append("\n");
+    sb.append("}");
+    return sb.toString();
+  }
+
+  /**
+   * Convert the given object to string with each line indented by 4 spaces (except the first line).
+   */
+  private String toIndentedString(Object o) {
+    if (o == null) {
+      return "null";
+    }
+    return o.toString().replace("\n", "\n    ");
+  }
+}