diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java index 400f161dee2f..638e886f6451 100644 --- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java +++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/DataflowPipelineJob.java @@ -57,6 +57,11 @@ "nullness", // TODO(https://github.com/apache/beam/issues/20497) "Slf4jDoNotLogMessageOfExceptionExplicitly", // intended, sent full stacktrace to LOG.debug }) +/** + * Dataflow implementation of {@link PipelineResult}. + * + *
Note: This class represents a PipelineResult but uses a different name for historical reasons. + */ public class DataflowPipelineJob implements PipelineResult { private static final Logger LOG = LoggerFactory.getLogger(DataflowPipelineJob.class); 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 91313f3924aa..420e3ab4a5de 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 @@ -25,6 +25,16 @@ * Result of {@link Pipeline#run()}. * *
This is often a job handle to an underlying data processing engine. + * + *
All of the above represent implementations of {@link PipelineResult}, even if their names do + * not explicitly include "PipelineResult". */ public interface PipelineResult {