fix(doc): Fix return types for batch interface (#1645)

cindy-peng · cloud-java-bot · web-flow · commit 11892116f0fb · 2024-10-29T09:29:18.000-07:00
* fix(doc): Fix return types for batch interface

* chore: generate libraries at Tue Oct 29 00:30:42 UTC 2024

---------

Co-authored-by: cloud-java-bot &lt;cloud-java-bot@google.com&gt;
diff --git a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/Batch.java b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/Batch.java
@@ -53,9 +53,13 @@ interface Response {
   /**
    * {@inheritDoc}
    *
-   * <p>If an entity for {@code entity.getKey()} does not exists, {@code entity} is inserted.
+   * <p>If an entity for {@code entity.getKey()} does not exist, {@code entity} is inserted.
    * Otherwise, {@link #submit()} will throw a {@link DatastoreException} with {@link
    * DatastoreException#getReason()} equal to {@code "ALREADY_EXISTS"}.
+   *
+   * @param entity the entity to be added to the datastore
+   * @return The entity that was added
+   * @throws DatastoreException if there was any failure
    */
   @Override
   Entity add(FullEntity<?> entity);
@@ -67,17 +71,26 @@ interface Response {
    * exists, {@link #submit()} will throw a {@link DatastoreException} with {@link
    * DatastoreException#getReason()} equal to {@code "ALREADY_EXISTS"}. All entities in {@code
    * entities} whose key did not exist are inserted.
+   *
+   * @param entities entities to be added to the datastore
+   * @return A list of entities that have been added
+   * @throws DatastoreException if there was any failure
    */
   @Override
   List<Entity> add(FullEntity<?>... entities);
 
   /**
    * Submit the batch to the Datastore.
    *
-   * @throws DatastoreException if there was any failure or if batch is not longer active
+   * @return Response of the batch submit operation.
+   * @throws DatastoreException if there was any failure or if batch is no longer active
    */
   Response submit();
 
-  /** Returns the batch associated {@link Datastore}. */
+  /**
+   * Returns the batch associated {@link Datastore}.
+   *
+   * @return The batch associated datastore
+   */
   Datastore getDatastore();
 }
