This is an automated email from the ASF dual-hosted git repository.
mxm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new e845da1 [BEAM-6730] Update docs for Python generate_sequence transform
new 23276fe Merge pull request #8321: [BEAM-6730] Update docs for Python
generate_sequence transform
e845da1 is described below
commit e845da1f478d2475624223db3a08a4ccc856cd90
Author: Maximilian Michels <m...@apache.org>
AuthorDate: Tue Apr 16 15:01:05 2019 +0200
[BEAM-6730] Update docs for Python generate_sequence transform
This provides more documentation similar to `kafka.py` to prevent users from
getting confused about how to use this external transform.
---
.../apache_beam/io/external/generate_sequence.py | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/sdks/python/apache_beam/io/external/generate_sequence.py
b/sdks/python/apache_beam/io/external/generate_sequence.py
index 4c9d0b8..8de68ab 100644
--- a/sdks/python/apache_beam/io/external/generate_sequence.py
+++ b/sdks/python/apache_beam/io/external/generate_sequence.py
@@ -27,7 +27,25 @@ from apache_beam.transforms import ptransform
class GenerateSequence(ptransform.PTransform):
"""
- A PTransform that provides a bounded or unbounded stream of integers.
+ An external PTransform which provides a bounded or unbounded stream of
+ integers.
+
+ Note: To use this transform, you need to start the Java expansion service.
+ Please refer to the portability documentation on how to do that. The
+ expansion service address has to be provided when instantiating this
+ transform. During pipeline translation this transform will be replaced by
+ the Java SDK's GenerateSequence.
+
+ If you start Flink's job server, the expansion service will be started on
+ port 8097. This is also the configured default for this transform. For a
+ different address, please set the expansion_service parameter.
+
+ For more information see:
+ - https://beam.apache.org/documentation/runners/flink/
+ - https://beam.apache.org/roadmap/portability/
+
+ Note: Runners need to support translating Read operations in order to use
+ this source. At the moment only the Flink Runner supports this.
"""
def __init__(self, start, stop=None,
