Clarify javadoc on PTransformTranslation
Project: http://git-wip-us.apache.org/repos/asf/beam/repo Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/ae7bc1d7 Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/ae7bc1d7 Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/ae7bc1d7 Branch: refs/heads/master Commit: ae7bc1d781f793d5091b70bab1c788b795866a8f Parents: 1cc6dc1 Author: Kenneth Knowles <[email protected]> Authored: Mon Jun 5 19:47:31 2017 -0700 Committer: Kenneth Knowles <[email protected]> Committed: Mon Jun 5 19:48:27 2017 -0700 ---------------------------------------------------------------------- .../beam/runners/core/construction/PTransformTranslation.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam/blob/ae7bc1d7/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/PTransformTranslation.java ---------------------------------------------------------------------- diff --git a/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/PTransformTranslation.java b/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/PTransformTranslation.java index fd3f9f3..fcbe84b 100644 --- a/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/PTransformTranslation.java +++ b/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/PTransformTranslation.java @@ -29,6 +29,7 @@ import java.util.List; import java.util.Map; import java.util.ServiceLoader; import javax.annotation.Nullable; +import org.apache.beam.sdk.Pipeline; import org.apache.beam.sdk.common.runner.v1.RunnerApi; import org.apache.beam.sdk.common.runner.v1.RunnerApi.FunctionSpec; import org.apache.beam.sdk.runners.AppliedPTransform; @@ -123,7 +124,10 @@ public class PTransformTranslation { } /** - * Translates a non-composite {@link AppliedPTransform} into a runner API proto. + * Translates a composite {@link AppliedPTransform} into a runner API proto with no component + * transforms. + * + * <p>This should not be used when translating a {@link Pipeline}. * * <p>Does not register the {@code appliedPTransform} within the provided {@link SdkComponents}. */
