Improve eventual consistency javadoc

googleapis · Mar 1, 2016 · 8a43d04 · 8a43d04
1 parent 76e3b3e
commit 8a43d04
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/ReadOption.java b/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/ReadOption.java
@@ -30,7 +30,8 @@ public abstract class ReadOption implements Serializable {
   private static final long serialVersionUID = -4406964829189800528L;
 
   /**
-   * Specifies eventual consistency for reads from Datastore.
+   * Specifies eventual consistency for reads from Datastore. Lookup and query operations using this
+   * option permit Datastore to return stale results.
    */
   public static final class EventualConsistency extends ReadOption {
 
@@ -50,7 +51,8 @@ public boolean isEventual() {
   private ReadOption() {}
 
   /**
-   * Returns a {@code ReadOption} that specifies eventual consistency.
+   * Returns a {@code ReadOption} that specifies eventual consistency, allowing Datastore to return
+   * stale results for getting/fetching entities or running queries.
    */
   public static EventualConsistency eventualConsistency() {
     return new EventualConsistency(true);