diff options
author | cody koeninger <cody@koeninger.org> | 2015-08-06 14:37:25 -0700 |
---|---|---|
committer | Tathagata Das <tathagata.das1565@gmail.com> | 2015-08-06 14:37:25 -0700 |
commit | 1723e34893f9b087727ea0e5c8b335645f42c295 (patch) | |
tree | a1c47e89683645af06faad1fb44c7c57fbd1a161 /external/kafka/src/main | |
parent | 0a078303d08ad2bb92b9a8a6969563d75b512290 (diff) | |
download | spark-1723e34893f9b087727ea0e5c8b335645f42c295.tar.gz spark-1723e34893f9b087727ea0e5c8b335645f42c295.tar.bz2 spark-1723e34893f9b087727ea0e5c8b335645f42c295.zip |
[DOCS] [STREAMING] make the existing parameter docs for OffsetRange ac…
…tually visible
Author: cody koeninger <cody@koeninger.org>
Closes #7995 from koeninger/doc-fixes and squashes the following commits:
87af9ea [cody koeninger] [Docs][Streaming] make the existing parameter docs for OffsetRange actually visible
Diffstat (limited to 'external/kafka/src/main')
-rw-r--r-- | external/kafka/src/main/scala/org/apache/spark/streaming/kafka/OffsetRange.scala | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/external/kafka/src/main/scala/org/apache/spark/streaming/kafka/OffsetRange.scala b/external/kafka/src/main/scala/org/apache/spark/streaming/kafka/OffsetRange.scala index f326e7f1f6..2f8981d489 100644 --- a/external/kafka/src/main/scala/org/apache/spark/streaming/kafka/OffsetRange.scala +++ b/external/kafka/src/main/scala/org/apache/spark/streaming/kafka/OffsetRange.scala @@ -42,16 +42,16 @@ trait HasOffsetRanges { * :: Experimental :: * Represents a range of offsets from a single Kafka TopicAndPartition. Instances of this class * can be created with `OffsetRange.create()`. + * @param topic Kafka topic name + * @param partition Kafka partition id + * @param fromOffset Inclusive starting offset + * @param untilOffset Exclusive ending offset */ @Experimental final class OffsetRange private( - /** Kafka topic name */ val topic: String, - /** Kafka partition id */ val partition: Int, - /** inclusive starting offset */ val fromOffset: Long, - /** exclusive ending offset */ val untilOffset: Long) extends Serializable { import OffsetRange.OffsetRangeTuple |