Annotate internal-only bits of Java sdk.runners
Project: http://git-wip-us.apache.org/repos/asf/beam/repo Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/fe51cc0d Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/fe51cc0d Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/fe51cc0d Branch: refs/heads/master Commit: fe51cc0d1a8aa14adbee81b220f9ca8a442f26fe Parents: 9b8a4e5 Author: Kenneth Knowles <[email protected]> Authored: Tue May 2 20:05:45 2017 -0700 Committer: Kenneth Knowles <[email protected]> Committed: Thu May 4 06:09:32 2017 -0700 ---------------------------------------------------------------------- .../java/org/apache/beam/sdk/runners/PTransformMatcher.java | 6 +++++- .../java/org/apache/beam/sdk/runners/PTransformOverride.java | 6 +++++- .../org/apache/beam/sdk/runners/PTransformOverrideFactory.java | 6 +++++- .../org/apache/beam/sdk/runners/PipelineRunnerRegistrar.java | 4 ++++ .../java/org/apache/beam/sdk/runners/TransformHierarchy.java | 6 +++++- 5 files changed, 24 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam/blob/fe51cc0d/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformMatcher.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformMatcher.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformMatcher.java index 30dca6d..6378ecc 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformMatcher.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformMatcher.java @@ -20,12 +20,16 @@ package org.apache.beam.sdk.runners; import org.apache.beam.sdk.annotations.Experimental; import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.apache.beam.sdk.annotations.Internal; import org.apache.beam.sdk.transforms.AppliedPTransform; import org.apache.beam.sdk.transforms.PTransform; /** - * Matches applications of {@link PTransform PTransforms}. + * <b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + * + * <p>Matches applications of {@link PTransform PTransforms}. */ +@Internal @Experimental(Kind.CORE_RUNNERS_ONLY) public interface PTransformMatcher { boolean matches(AppliedPTransform<?, ?, ?> application); http://git-wip-us.apache.org/repos/asf/beam/blob/fe51cc0d/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverride.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverride.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverride.java index 33b9114..2820364 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverride.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverride.java @@ -19,12 +19,16 @@ package org.apache.beam.sdk.runners; import com.google.auto.value.AutoValue; +import org.apache.beam.sdk.annotations.Internal; import org.apache.beam.sdk.transforms.PTransform; /** - * A {@link PTransformMatcher} and associated {@link PTransformOverrideFactory} to replace all + * <b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + * + * <p>A {@link PTransformMatcher} and associated {@link PTransformOverrideFactory} to replace all * matching {@link PTransform PTransforms}. */ +@Internal @AutoValue public abstract class PTransformOverride { public static PTransformOverride of( http://git-wip-us.apache.org/repos/asf/beam/blob/fe51cc0d/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverrideFactory.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverrideFactory.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverrideFactory.java index 786c61c..a28f303 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverrideFactory.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PTransformOverrideFactory.java @@ -23,6 +23,7 @@ import com.google.auto.value.AutoValue; import java.util.Map; import org.apache.beam.sdk.annotations.Experimental; import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.apache.beam.sdk.annotations.Internal; import org.apache.beam.sdk.transforms.AppliedPTransform; import org.apache.beam.sdk.transforms.PTransform; import org.apache.beam.sdk.values.PInput; @@ -32,9 +33,12 @@ import org.apache.beam.sdk.values.TaggedPValue; import org.apache.beam.sdk.values.TupleTag; /** - * Produces {@link PipelineRunner}-specific overrides of {@link PTransform PTransforms}, and + * <b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + * + * <p>Produces {@link PipelineRunner}-specific overrides of {@link PTransform PTransforms}, and * provides mappings between original and replacement outputs. */ +@Internal @Experimental(Kind.CORE_RUNNERS_ONLY) public interface PTransformOverrideFactory< InputT extends PInput, http://git-wip-us.apache.org/repos/asf/beam/blob/fe51cc0d/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PipelineRunnerRegistrar.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PipelineRunnerRegistrar.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PipelineRunnerRegistrar.java index be95044..41fd6f0 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PipelineRunnerRegistrar.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/PipelineRunnerRegistrar.java @@ -19,8 +19,11 @@ package org.apache.beam.sdk.runners; import com.google.auto.service.AutoService; import java.util.ServiceLoader; +import org.apache.beam.sdk.annotations.Internal; /** + * <b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + * * {@link PipelineRunner} creators have the ability to automatically have their * {@link PipelineRunner} registered with this SDK by creating a {@link ServiceLoader} entry * and a concrete implementation of this interface. @@ -33,6 +36,7 @@ import java.util.ServiceLoader; * <p>It is optional but recommended to use one of the many build time tools such as * {@link AutoService} to generate the necessary META-INF files automatically. */ +@Internal public interface PipelineRunnerRegistrar { /** * Get the set of {@link PipelineRunner PipelineRunners} to register. http://git-wip-us.apache.org/repos/asf/beam/blob/fe51cc0d/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/TransformHierarchy.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/TransformHierarchy.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/TransformHierarchy.java index 18bf2e9..9236194 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/TransformHierarchy.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/runners/TransformHierarchy.java @@ -36,6 +36,7 @@ import javax.annotation.Nullable; import org.apache.beam.sdk.Pipeline; import org.apache.beam.sdk.Pipeline.PipelineVisitor; import org.apache.beam.sdk.Pipeline.PipelineVisitor.CompositeBehavior; +import org.apache.beam.sdk.annotations.Internal; import org.apache.beam.sdk.runners.PTransformOverrideFactory.ReplacementOutput; import org.apache.beam.sdk.transforms.AppliedPTransform; import org.apache.beam.sdk.transforms.PTransform; @@ -47,9 +48,12 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Captures information about a collection of transformations and their + * <b><i>For internal use only; no backwards-compatibility guarantees.</i></b> + * + * <p>Captures information about a collection of transformations and their * associated {@link PValue}s. */ +@Internal public class TransformHierarchy { private static final Logger LOG = LoggerFactory.getLogger(TransformHierarchy.class);
