kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mj...@apache.org
Subject [kafka] branch 2.3 updated: KAFKA-9068: Fix javadoc of Stores.{persistent, inMemory}SessionStore (#7908)
Date Thu, 09 Jan 2020 03:11:18 GMT
This is an automated email from the ASF dual-hosted git repository.

mjsax pushed a commit to branch 2.3
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/2.3 by this push:
     new 829fdaf  KAFKA-9068: Fix javadoc of Stores.{persistent,inMemory}SessionStore (#7908)
829fdaf is described below

commit 829fdaf26a2c3c1fee6dd6d68abcbd82811af503
Author: David Kim <zealiard@gmail.com>
AuthorDate: Thu Jan 9 12:08:58 2020 +0900

    KAFKA-9068: Fix javadoc of Stores.{persistent,inMemory}SessionStore (#7908)
    
    Reviewer: Matthias J. Sax <matthias@confluent.io>
---
 .../java/org/apache/kafka/streams/state/Stores.java   | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)

diff --git a/streams/src/main/java/org/apache/kafka/streams/state/Stores.java b/streams/src/main/java/org/apache/kafka/streams/state/Stores.java
index 2f81fd3..9164970 100644
--- a/streams/src/main/java/org/apache/kafka/streams/state/Stores.java
+++ b/streams/src/main/java/org/apache/kafka/streams/state/Stores.java
@@ -357,10 +357,9 @@ public final class Stores {
      * Create a persistent {@link SessionBytesStoreSupplier}.
      *
      * @param name              name of the store (cannot be {@code null})
-     * @param retentionPeriodMs length ot time to retain data in the store (cannot be negative)
-     *                          (note that the retention period must be at least long enough
to contain the
-     *                          windowed data's entire life cycle, from window-start through
window-end,
-     *                          and for the entire grace period)
+     * @param retentionPeriodMs length of time to retain data in the store (cannot be negative)
+     *                          (note that the retention period must be at least as long
enough to
+     *                          contain the inactivity gap of the session and the entire
grace period.)
      * @return an instance of a {@link  SessionBytesStoreSupplier}
      * @deprecated since 2.1 Use {@link Stores#persistentSessionStore(String, Duration)}
instead
      */
@@ -378,10 +377,9 @@ public final class Stores {
      * Create a persistent {@link SessionBytesStoreSupplier}.
      *
      * @param name              name of the store (cannot be {@code null})
-     * @param retentionPeriod   length ot time to retain data in the store (cannot be negative)
-     *                          Note that the retention period must be at least long enough
to contain the
-     *                          windowed data's entire life cycle, from window-start through
window-end,
-     *                          and for the entire grace period.
+     * @param retentionPeriod   length of time to retain data in the store (cannot be negative)
+     *                          (note that the retention period must be at least as long
enough to
+     *                          contain the inactivity gap of the session and the entire
grace period.)
      * @return an instance of a {@link  SessionBytesStoreSupplier}
      */
     @SuppressWarnings("deprecation") // removing #persistentSessionStore(String name, long
retentionPeriodMs) will fix this
@@ -396,9 +394,8 @@ public final class Stores {
      *
      * @param name              name of the store (cannot be {@code null})
      * @param retentionPeriod   length ot time to retain data in the store (cannot be negative)
-     *                          Note that the retention period must be at least long enough
to contain the
-     *                          windowed data's entire life cycle, from window-start through
window-end,
-     *                          and for the entire grace period.
+     *                          (note that the retention period must be at least as long
enough to
+     *                          contain the inactivity gap of the session and the entire
grace period.)
      * @return an instance of a {@link  SessionBytesStoreSupplier}
      */
     public static SessionBytesStoreSupplier inMemorySessionStore(final String name, final
Duration retentionPeriod) {


Mime
View raw message