Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 29, 2024
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4d9cce
fix(doc): Fix return types for batch interface
cindy-peng Oct 29, 2024
1badd44
chore: generate libraries at Tue Oct 29 00:30:42 UTC 2024
cloud-java-bot Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions google-cloud-datastore/src/main/java/com/google/cloud/datastore/Batch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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();
}
Loading