Repository: beam Updated Branches: refs/heads/master f7e8f886c -> 3a8b0b68c
Fix Javadoc for waitUntilFinish Project: http://git-wip-us.apache.org/repos/asf/beam/repo Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/9ff3ac3d Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/9ff3ac3d Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/9ff3ac3d Branch: refs/heads/master Commit: 9ff3ac3dcd61a310ed52d9bbc9f133a5ae5fb445 Parents: f7e8f88 Author: Thomas Groh <[email protected]> Authored: Tue Aug 15 13:26:02 2017 -0700 Committer: Thomas Groh <[email protected]> Committed: Tue Aug 15 13:26:02 2017 -0700 ---------------------------------------------------------------------- .../main/java/org/apache/beam/sdk/PipelineResult.java | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam/blob/9ff3ac3d/sdks/java/core/src/main/java/org/apache/beam/sdk/PipelineResult.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/PipelineResult.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/PipelineResult.java index b60de63..4a9c30a 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/PipelineResult.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/PipelineResult.java @@ -46,14 +46,14 @@ public interface PipelineResult { State cancel() throws IOException; /** - * Waits until the pipeline finishes and returns the final status. - * It times out after the given duration. - * - * @param duration The time to wait for the pipeline to finish. - * Provide a value less than 1 ms for an infinite wait. + * Waits until the pipeline finishes and returns the final status. It times out after the given + * duration. * + * @param duration The time to wait for the pipeline to finish. Provide a value less than 1 ms for + * an infinite wait. * @return The final state of the pipeline or null on timeout. - * @throws UnsupportedOperationException if the runner does not support cancellation. + * @throws UnsupportedOperationException if the runner does not support waiting to finish with a + * timeout. */ State waitUntilFinish(Duration duration); @@ -61,7 +61,7 @@ public interface PipelineResult { * Waits until the pipeline finishes and returns the final status. * * @return The final state of the pipeline. - * @throws UnsupportedOperationException if the runner does not support cancellation. + * @throws UnsupportedOperationException if the runner does not support waiting to finish. */ State waitUntilFinish();
