feat: add data.replace method

Author: bevzzz

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

@@ -180,9 +180,30 @@ public void testReferences_AddReplaceDelete() throws IOException {
   }
 
   @Test
-  public void testReplace() {
-    // Replace (PUT):
-    // properties, reference, vectors
+  public void testReplace() throws IOException {
+    // Arrange
+    var nsBooks = ns("Books");
+
+    client.collections.create(nsBooks,
+        collection -> collection
+            .properties(Property.text("title"), Property.integer("year")));
+
+    // Add 1 book with 'title' only.
+    var books = client.collections.use(nsBooks);
+    var ivanhoe = books.data.insert(Map.of("title", "ivanhoe"));
+
+    // Act
+    books.data.replace(ivanhoe.metadata().uuid(),
+        replace -> replace.properties(Map.of("year", 1819)));
+
+    // Assert
+    var replacedIvanhoe = books.query.byId(ivanhoe.metadata().uuid());
+
+    Assertions.assertThat(replacedIvanhoe).get()
+        .as("has ONLY year property")
+        .extracting(WeaviateObject::properties, InstanceOfAssertFactories.MAP)
+        .doesNotContain(Map.entry("title", "ivanhoe"))
+        .contains(Map.entry("year", 1819L));
   }
 
   @Test
@@ -231,9 +252,9 @@ public void testUpdate() throws IOException {
     Assertions.assertThat(updIvanhoe).get()
         .satisfies(book -> {
           Assertions.assertThat(book)
-              .as("has year property")
+              .as("has both year and title property")
               .extracting(WeaviateObject::properties, InstanceOfAssertFactories.MAP)
-              .contains(Map.entry("year", 1819L));
+              .contains(Map.entry("title", "ivanhoe"), Map.entry("year", 1819L));
 
           Assertions.assertThat(book)
               .as("has reference to Authors")

src/main/java/io/weaviate/client6/v1/api/collections/data/ReplaceObjectRequest.java

@@ -0,0 +1,68 @@
+package io.weaviate.client6.v1.api.collections.data;
+
+import java.util.Collections;
+import java.util.function.Function;
+
+import com.google.gson.reflect.TypeToken;
+
+import io.weaviate.client6.v1.api.collections.ObjectMetadata;
+import io.weaviate.client6.v1.api.collections.Vectors;
+import io.weaviate.client6.v1.api.collections.WeaviateObject;
+import io.weaviate.client6.v1.internal.ObjectBuilder;
+import io.weaviate.client6.v1.internal.json.JSON;
+import io.weaviate.client6.v1.internal.orm.CollectionDescriptor;
+import io.weaviate.client6.v1.internal.rest.Endpoint;
+
+public record ReplaceObjectRequest<T>(WeaviateObject<T, Reference, ObjectMetadata> object) {
+
+  static final <T> Endpoint<ReplaceObjectRequest<T>, Void> endpoint(CollectionDescriptor<T> collectionDescriptor) {
+    return Endpoint.of(
+        request -> "PUT",
+        request -> "/objects/" + collectionDescriptor.name() + "/" + request.object.metadata().uuid(),
+        (gson, request) -> JSON.serialize(request.object, TypeToken.getParameterized(
+            WeaviateObject.class, collectionDescriptor.typeToken().getType(), Reference.class, ObjectMetadata.class)),
+        request -> Collections.emptyMap(),
+        code -> code != 200,
+        (gson, response) -> null);
+  }
+
+  public static <T> ReplaceObjectRequest<T> of(String collectionName, String uuid,
+      Function<ReplaceObjectRequest.Builder<T>, ObjectBuilder<ReplaceObjectRequest<T>>> fn) {
+    return fn.apply(new Builder<>(collectionName, uuid)).build();
+  }
+
+  public ReplaceObjectRequest(Builder<T> builder) {
+    this(builder.object.build());
+  }
+
+  public static class Builder<T> implements ObjectBuilder<ReplaceObjectRequest<T>> {
+    private final WeaviateObject.Builder<T, Reference, ObjectMetadata> object = new WeaviateObject.Builder<>();
+    private final ObjectMetadata.Builder metadata = new ObjectMetadata.Builder();
+
+    public Builder(String collectionName, String uuid) {
+      this.object.collection(collectionName);
+      this.metadata.uuid(uuid);
+    }
+
+    public Builder<T> properties(T properties) {
+      this.object.properties(properties);
+      return this;
+    }
+
+    public Builder<T> vectors(Vectors vectors) {
+      this.metadata.vectors(vectors);
+      return this;
+    }
+
+    public Builder<T> reference(String property, Reference... references) {
+      this.object.reference(property, references);
+      return this;
+    }
+
+    @Override
+    public ReplaceObjectRequest<T> build() {
+      this.object.metadata(this.metadata.build());
+      return new ReplaceObjectRequest<>(this);
+    }
+  }
+}

src/main/java/io/weaviate/client6/v1/api/collections/data/UpdateObjectRequest.java

@@ -26,9 +26,9 @@ static final <T> Endpoint<UpdateObjectRequest<T>, Void> endpoint(CollectionDescr
         (gson, response) -> null);
   }
 
-  public static <T> UpdateObjectRequest<T> of(String uuid,
+  public static <T> UpdateObjectRequest<T> of(String collectionName, String uuid,
       Function<UpdateObjectRequest.Builder<T>, ObjectBuilder<UpdateObjectRequest<T>>> fn) {
-    return fn.apply(new Builder<>(uuid)).build();
+    return fn.apply(new Builder<>(collectionName, uuid)).build();
   }
 
   public UpdateObjectRequest(Builder<T> builder) {
@@ -39,7 +39,8 @@ public static class Builder<T> implements ObjectBuilder<UpdateObjectRequest<T>>
     private final WeaviateObject.Builder<T, Reference, ObjectMetadata> object = new WeaviateObject.Builder<>();
     private final ObjectMetadata.Builder metadata = new ObjectMetadata.Builder();
 
-    public Builder(String uuid) {
+    public Builder(String collectionName, String uuid) {
+      this.object.collection(collectionName);
       this.metadata.uuid(uuid);
     }
 

src/main/java/io/weaviate/client6/v1/api/collections/data/WeaviateDataClient.java

@@ -43,10 +43,16 @@ public boolean exists(String uuid) throws IOException {
 
   public void update(String uuid, Function<UpdateObjectRequest.Builder<T>, ObjectBuilder<UpdateObjectRequest<T>>> fn)
       throws IOException {
-    this.restTransport.performRequest(UpdateObjectRequest.of(uuid, fn),
+    this.restTransport.performRequest(UpdateObjectRequest.of(collectionDescriptor.name(), uuid, fn),
         UpdateObjectRequest.endpoint(collectionDescriptor));
   }
 
+  public void replace(String uuid, Function<ReplaceObjectRequest.Builder<T>, ObjectBuilder<ReplaceObjectRequest<T>>> fn)
+      throws IOException {
+    this.restTransport.performRequest(ReplaceObjectRequest.of(collectionDescriptor.name(), uuid, fn),
+        ReplaceObjectRequest.endpoint(collectionDescriptor));
+  }
+
   public void delete(String uuid) throws IOException {
     this.restTransport.performRequest(new DeleteObjectRequest(collectionDescriptor.name(), uuid),
         DeleteObjectRequest._ENDPOINT);