beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From k...@apache.org
Subject [1/2] beam git commit: Correct Javadoc on accessing windows in DoFn
Date Tue, 14 Feb 2017 04:44:39 GMT
Repository: beam
Updated Branches:
  refs/heads/master 98d8834af -> 49809d1d4


Correct Javadoc on accessing windows in DoFn


Project: http://git-wip-us.apache.org/repos/asf/beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/c1c8d838
Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/c1c8d838
Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/c1c8d838

Branch: refs/heads/master
Commit: c1c8d8386fc035c65362b5ce36c20b38fe00f9a4
Parents: 0e6b379
Author: Ben Chambers <bjchambers@users.noreply.github.com>
Authored: Wed Feb 1 15:08:13 2017 -0800
Committer: Kenneth Knowles <klk@google.com>
Committed: Mon Feb 13 20:44:04 2017 -0800

----------------------------------------------------------------------
 .../src/main/java/org/apache/beam/sdk/transforms/DoFn.java     | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam/blob/c1c8d838/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
index a161919..1ad05bb 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFn.java
@@ -532,8 +532,10 @@ public abstract class DoFn<InputT, OutputT> implements Serializable,
HasDisplayD
    *     href="https://s.apache.org/splittable-do-fn">splittable</a> {@link DoFn}
subject to the
    *     separate requirements described below. Items below are assuming this is not a splittable
    *     {@link DoFn}.
-   * <li>If one of its arguments is {@link BoundedWindow}, this argument corresponds
to the window
-   *     of the current element. If absent, a runner may perform additional optimizations.
+   * <li>If one of its arguments is a subtype of {@link BoundedWindow} then it will
+   *     be passed the window of the current element. When applied by {@link ParDo} the subtype
+   *     of {@link BoundedWindow} must match the type of windows on the input {@link PCollection}.
+   *     If the window is not accessed a runner may perform additional optimizations.
    * <li>It must return {@code void}.
    * </ul>
    *


Mime
View raw message