[DOCS-3754] Event Feeds: Document pageSize limit

fauna · Nov 19, 2024 · 73ebcb1 · 73ebcb1
2 parents 2a2be0e + eed83b6
commit 73ebcb1
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/java/com/fauna/event/FeedOptions.java b/src/main/java/com/fauna/event/FeedOptions.java
@@ -30,7 +30,9 @@ public class FeedOptions {
      *                 {@code startTs}.
      * @param startTs  A {@code Long} representing the start timestamp for the feed. Represents a time in microseconds since the Unix epoch. Cannot be provided with a
      *                 {@code cursor}.
-     * @param pageSize An {@code Integer} specifying the number of items per feed page.
+     * @param pageSize An {@code Integer} specifying the maximum number of
+*                      events returned per page. Must be in the range 1 to 16000
+*                      (inclusive). Defaults to 16.
      * @param timeout  A {@code Duration} specifying the timeout for the feed request.
      * @throws IllegalArgumentException if both {@code cursor} and {@code startTs} are set.
      */