[samza] 03/03: [javadoc] Clarify semantics of the offset in IncomingMessageEnvelope as the offset provided by the system consumer for the message (#945)

[shanthoosh]

This is an automated email from the ASF dual-hosted git repository.

shanthoosh pushed a commit to branch 1.1.0
in repository https://gitbox.apache.org/repos/asf/samza.git

commit a9aa1c752dbe99c825513f6fdfc960a5b311f64e
Author: cameronlee314 <37879374+cameronlee...@users.noreply.github.com>
AuthorDate: Fri Mar 8 15:16:08 2019 -0800

    [javadoc] Clarify semantics of the offset in IncomingMessageEnvelope as the 
offset provided by the system consumer for the message (#945)
---
 .../java/org/apache/samza/system/IncomingMessageEnvelope.java    | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git 
a/samza-api/src/main/java/org/apache/samza/system/IncomingMessageEnvelope.java 
b/samza-api/src/main/java/org/apache/samza/system/IncomingMessageEnvelope.java
index ae8335e..7392253 100644
--- 
a/samza-api/src/main/java/org/apache/samza/system/IncomingMessageEnvelope.java
+++ 
b/samza-api/src/main/java/org/apache/samza/system/IncomingMessageEnvelope.java
@@ -46,7 +46,7 @@ public class IncomingMessageEnvelope {
    * Constructs a new IncomingMessageEnvelope from specified components.
    * @param systemStreamPartition The aggregate object representing the 
incoming stream name, the name of the cluster
    * from which the stream came, and the partition of the stream from which 
the message was received.
-   * @param offset The offset in the partition that the message was received 
from.
+   * @param offset offset associated with this message, provided by the system 
consumer that consumed the message
    * @param key A deserialized key received from the partition offset.
    * @param message A deserialized message received from the partition offset.
    */
@@ -58,7 +58,7 @@ public class IncomingMessageEnvelope {
    * Constructs a new IncomingMessageEnvelope from specified components.
    * @param systemStreamPartition The aggregate object representing the 
incoming stream name, the name of the cluster
    * from which the stream came, and the partition of the stream from which 
the message was received.
-   * @param offset The offset in the partition that the message was received 
from.
+   * @param offset offset associated with this message, provided by the system 
consumer that consumed the message
    * @param key A deserialized key received from the partition offset.
    * @param message A deserialized message received from the partition offset.
    * @param size size of the message and key in bytes.
@@ -77,7 +77,7 @@ public class IncomingMessageEnvelope {
    * Constructs a new IncomingMessageEnvelope from specified components
    * @param systemStreamPartition The aggregate object representing the 
incoming stream name, the name of the cluster
    * from which the stream came, and the partition of the stream from which 
the message was received.
-   * @param offset The offset in the partition that the message was received 
from.
+   * @param offset offset associated with this message, provided by the system 
consumer that consumed the message
    * @param key A deserialized key received from the partition offset.
    * @param message A deserialized message received from the partition offset.
    * @param size size of the message and key in bytes.
@@ -111,6 +111,9 @@ public class IncomingMessageEnvelope {
     return systemStreamPartition;
   }
 
+  /**
+   * Offset associated with this message, provided by the system consumer that 
consumed the message.
+   */
   public String getOffset() {
     return offset;
   }