feat(export): make fileFormat a required parameter

Author: bevzzz

src/it/java/io/weaviate/integration/ExportITest.java

@@ -14,6 +14,7 @@
 import io.weaviate.client6.v1.api.WeaviateClient;
 import io.weaviate.client6.v1.api.export.Export;
 import io.weaviate.client6.v1.api.export.ExportStatus;
+import io.weaviate.client6.v1.api.export.FileFormat;
 import io.weaviate.client6.v1.api.export.ShardExportProgress;
 import io.weaviate.containers.Weaviate;
 
@@ -45,7 +46,7 @@ public void test_lifecycle() throws IOException, TimeoutException {
     }
 
     // Act: start export
-    var started = client.export.create(exportId, backend,
+    var started = client.export.create(exportId, backend, FileFormat.PARQUET,
         export -> export
             .includeCollections(nsA, nsB));
 

src/main/java/io/weaviate/client6/v1/api/export/CreateExportRequest.java

@@ -13,13 +13,13 @@
 import io.weaviate.client6.v1.internal.rest.Endpoint;
 import io.weaviate.client6.v1.internal.rest.SimpleEndpoint;
 
-public record CreateExportRequest(ExportCreate body, String backend) {
+public record CreateExportRequest(ExportCreate config, String backend) {
 
   public static Endpoint<CreateExportRequest, Export> _ENDPOINT = new SimpleEndpoint<>(
       request -> "POST",
       request -> "/export/" + request.backend,
       request -> Collections.emptyMap(),
-      request -> JSON.serialize(request.body),
+      request -> JSON.serialize(request.config),
       (statusCode, response) -> JSON.deserialize(response, Export.class));
 
   public static record ExportCreate(
@@ -28,12 +28,13 @@ public static record ExportCreate(
       @SerializedName("include") List<String> includeCollections,
       @SerializedName("exclude") List<String> excludeCollections) {
 
-    public static ExportCreate of(String exportId) {
-      return of(exportId, ObjectBuilder.identity());
+    public static ExportCreate of(String exportId, FileFormat fileFormat) {
+      return of(exportId, fileFormat, ObjectBuilder.identity());
     }
 
-    public static ExportCreate of(String exportId, Function<Builder, ObjectBuilder<ExportCreate>> fn) {
-      return fn.apply(new Builder(exportId)).build();
+    public static ExportCreate of(String exportId, FileFormat fileFormat,
+        Function<Builder, ObjectBuilder<ExportCreate>> fn) {
+      return fn.apply(new Builder(exportId, fileFormat)).build();
     }
 
     public ExportCreate(Builder builder) {
@@ -46,13 +47,14 @@ public ExportCreate(Builder builder) {
 
     public static class Builder implements ObjectBuilder<ExportCreate> {
       private final String exportId;
+      private FileFormat fileFormat;
 
-      private FileFormat fileFormat = FileFormat.PARQUET;
       private final List<String> includeCollections = new ArrayList<>();
       private final List<String> excludeCollections = new ArrayList<>();
 
-      public Builder(String exportId) {
+      public Builder(String exportId, FileFormat fileFormat) {
         this.exportId = exportId;
+        this.fileFormat = fileFormat;
       }
 
       /** Collection that should be included in the export. */
@@ -77,12 +79,6 @@ public Builder excludeCollections(List<String> excludeCollections) {
         return this;
       }
 
-      /** Export file format. */
-      public Builder fileFormat(FileFormat fileFormat) {
-        this.fileFormat = fileFormat;
-        return this;
-      }
-
       @Override
       public ExportCreate build() {
         return new ExportCreate(this);

src/main/java/io/weaviate/client6/v1/api/export/WeaviateExportClient.java

@@ -26,8 +26,8 @@ public WeaviateExportClient(RestTransport restTransport) {
    *                              due to a malformed request, a networking error
    *                              or the server being unavailable.
    */
-  public Export create(String exportId, String backend) throws IOException {
-    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId), backend));
+  public Export create(String exportId, String backend, FileFormat fileFormat) throws IOException {
+    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId, fileFormat), backend));
   }
 
   /**
@@ -42,10 +42,10 @@ public Export create(String exportId, String backend) throws IOException {
    *                              due to a malformed request, a networking error
    *                              or the server being unavailable.
    */
-  public Export create(String exportId, String backend,
+  public Export create(String exportId, String backend, FileFormat fileFormat,
       Function<CreateExportRequest.ExportCreate.Builder, ObjectBuilder<CreateExportRequest.ExportCreate>> fn)
       throws IOException {
-    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId, fn), backend));
+    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId, fileFormat, fn), backend));
   }
 
   /**
@@ -58,7 +58,7 @@ public Export create(String exportId, String backend,
    *                              due to a malformed request, a networking error
    *                              or the server being unavailable.
    */
-  public Export create(CreateExportRequest request) throws IOException {
+  private Export create(CreateExportRequest request) throws IOException {
     return this.restTransport.performRequest(request, CreateExportRequest._ENDPOINT);
   }
 

src/main/java/io/weaviate/client6/v1/api/export/WeaviateExportClientAsync.java

@@ -20,8 +20,8 @@ public WeaviateExportClientAsync(RestTransport restTransport) {
    * @param exportId Export ID. Must be unique for the backend.
    * @param backend  Export storage backend.
    */
-  public CompletableFuture<Export> create(String exportId, String backend) {
-    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId), backend));
+  public CompletableFuture<Export> create(String exportId, String backend, FileFormat fileFormat) {
+    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId, fileFormat), backend));
   }
 
   /**
@@ -31,17 +31,17 @@ public CompletableFuture<Export> create(String exportId, String backend) {
    * @param backend  Export storage backend.
    * @param fn       Lambda expression for optional parameters.
    */
-  public CompletableFuture<Export> create(String exportId, String backend,
+  public CompletableFuture<Export> create(String exportId, String backend, FileFormat fileFormat,
       Function<CreateExportRequest.ExportCreate.Builder, ObjectBuilder<CreateExportRequest.ExportCreate>> fn) {
-    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId, fn), backend));
+    return create(new CreateExportRequest(CreateExportRequest.ExportCreate.of(exportId, fileFormat, fn), backend));
   }
 
   /**
    * Start a new export process.
    *
    * @param request Create export request.
    */
-  public CompletableFuture<Export> create(CreateExportRequest request) {
+  private CompletableFuture<Export> create(CreateExportRequest request) {
     return this.restTransport.performRequestAsync(request, CreateExportRequest._ENDPOINT);
   }