Deprecated List (Apache Beam 2.5.0)

Deprecated Interfaces
Interface and Description
org.apache.beam.runners.dataflow.options.DataflowWorkerLoggingOptions This interface will no longer be the source of truth for worker logging configuration once jobs are executed using a dedicated SDK harness instead of user code being co-located alongside Dataflow worker code. Please set the option below and also the corresponding option within `SdkHarnessOptions` to ensure forward compatibility.
org.apache.beam.sdk.testing.StreamingIT tests which use unbounded PCollections should be in the category `UsesUnboundedPCollections`. Beyond that, it is up to the runner and test configuration to decide whether to run in streaming mode.

Deprecated Classes
Class and Description
org.apache.beam.sdk.coders.Coder.Context To implement a coder, do not use any `Coder.Context`. Just implement only those abstract methods which do not accept a `Coder.Context` and leave the default implementations for methods accepting a `Coder.Context`.
org.apache.beam.sdk.transforms.Combine.SimpleCombineFn
org.apache.beam.sdk.transforms.DoFnTester Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.Reshuffle this transform's intended side effects are not portable; it will likely be removed
org.apache.beam.sdk.transforms.windowing.ReshuffleTrigger The intended side effect of `Reshuffle` is not portable; it will likely be removed
org.apache.beam.runners.fnexecution.control.SingleEnvironmentInstanceJobBundleFactory replace with a `DockerJobBundleFactory` when appropriate if the `EnvironmentFactory` is a `DockerEnvironmentFactory`, or create an `InProcessJobBundleFactory` and inline the creation of the environment if appropriate.
org.apache.beam.sdk.transforms.Top.Largest use `Top.Natural` instead
org.apache.beam.sdk.transforms.Top.Smallest use `Top.Reversed` instead

Deprecated Enums
Enum and Description
org.apache.beam.sdk.io.CompressedSource.CompressionMode Use `Compression` instead
org.apache.beam.sdk.transforms.DoFnTester.CloningBehavior Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.io.FileBasedSink.CompressionType use `Compression`.
org.apache.beam.sdk.io.TextIO.CompressionType Use `Compression`.
org.apache.beam.sdk.io.TFRecordIO.CompressionType Use `Compression`.
org.apache.beam.sdk.io.xml.XmlIO.Read.CompressionType Use `Compression` instead.

Deprecated Methods
Method and Description
org.apache.beam.sdk.io.gcp.pubsub.PubsubIO.PubsubSubscription.asV1Beta1Path() the v1beta1 API for Cloud Pub/Sub is deprecated.
org.apache.beam.sdk.io.gcp.pubsub.PubsubIO.PubsubTopic.asV1Beta1Path() the v1beta1 API for Cloud Pub/Sub is deprecated.
org.apache.beam.sdk.io.gcp.pubsub.PubsubIO.PubsubSubscription.asV1Beta2Path() the v1beta2 API for Cloud Pub/Sub is deprecated.
org.apache.beam.sdk.io.gcp.pubsub.PubsubIO.PubsubTopic.asV1Beta2Path() the v1beta2 API for Cloud Pub/Sub is deprecated.
org.apache.beam.sdk.transforms.DoFnTester.clearOutputElements() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.clearOutputElements(TupleTag<T>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.close() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.io.AvroSource.createForSubrangeOfFile(String, long, long) Used by Dataflow worker
org.apache.beam.sdk.transforms.DoFnTester.createProcessContext(ValueInSingleWindow<InputT>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.coders.Coder.decode(InputStream, Coder.Context) only implement and call `Coder.decode(InputStream)`
org.apache.beam.sdk.coders.Coder.encode(T, OutputStream, Coder.Context) only implement and call `Coder.encode(Object value, OutputStream)`
org.apache.beam.sdk.testing.PAssert.PCollectionContentsAssert.equals(Object) `Object.equals(Object)` is not supported on PAssert objects. If you meant to test object equality, use a variant of `PAssert.PCollectionContentsAssert.containsInAnyOrder(T...)` instead.
org.apache.beam.sdk.values.PValue.expand() A `PValue` always expands into itself. Calling `PValue.expand()` on a PValue is almost never appropriate.
org.apache.beam.sdk.transforms.DoFnTester.finishBundle() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.WithTimestamps.getAllowedTimestampSkew() This method permits a to elements to be emitted behind the watermark. These elements are considered late, and if behind the `allowed lateness` of a downstream `PCollection` may be silently dropped. See https://issues.apache.org/jira/browse/BEAM-644 for details on a replacement.
org.apache.beam.sdk.transforms.DoFn.getAllowedTimestampSkew() This method permits a `DoFn` to emit elements behind the watermark. These elements are considered late, and if behind the `allowed lateness` of a downstream `PCollection` may be silently dropped. See https://issues.apache.org/jira/browse/BEAM-644 for details on a replacement.
org.apache.beam.sdk.io.gcp.bigtable.BigtableIO.Read.getBigtableOptions() will be replaced by bigtable options configurator.
org.apache.beam.sdk.io.gcp.bigtable.BigtableIO.Write.getBigtableOptions() will be replaced by bigtable options configurator.
org.apache.beam.sdk.transforms.DoFnTester.getCloningBehavior() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.coders.CoderRegistry.getCoder(Class<? extends T>, Class<T>, Map<Type, ? extends Coder<?>>, TypeVariable<?>) This method is to change in an unknown backwards incompatible way once support for this functionality is refined.
org.apache.beam.sdk.coders.CoderRegistry.getCoder(TypeDescriptor<OutputT>, TypeDescriptor<InputT>, Coder<InputT>) This method is to change in an unknown backwards incompatible way once support for this functionality is refined.
org.apache.beam.sdk.values.PCollectionView.getCoderInternal() this method will be removed entirely. The `PCollection` underlying a side input, including its `Coder`, is part of the side input's specification with a `ParDo` transform, which will obtain that information via a package-private channel.
org.apache.beam.sdk.io.Source.getDefaultOutputCoder() Override `Source.getOutputCoder()` instead.
org.apache.beam.sdk.transforms.PTransform.getDefaultOutputCoder() Instead, the PTransform should explicitly call `PCollection.setCoder(org.apache.beam.sdk.coders.Coder<T>)` on the returned PCollection.
org.apache.beam.sdk.transforms.PTransform.getDefaultOutputCoder(InputT) Instead, the PTransform should explicitly call `PCollection.setCoder(org.apache.beam.sdk.coders.Coder<T>)` on the returned PCollection.
org.apache.beam.sdk.transforms.PTransform.getDefaultOutputCoder(InputT, PCollection<T>) Instead, the PTransform should explicitly call `PCollection.setCoder(org.apache.beam.sdk.coders.Coder<T>)` on the returned PCollection.
org.apache.beam.runners.dataflow.util.MonitoringUtil.getJobMonitoringPageURL(String, String) this method defaults the region to "us-central1". Prefer using the overload with an explicit regionId parameter.
org.apache.beam.sdk.transforms.DoFnTester.getMainOutputTag() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.getMutableOutput(TupleTag<T>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.coders.CoderRegistry.getOutputCoder(SerializableFunction<InputT, OutputT>, Coder<InputT>) This method is to change in an unknown backwards incompatible way once support for this functionality is refined.
org.apache.beam.sdk.transforms.DoFnTester.getPipelineOptions() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.values.PCollectionView.getTagInternal() this method will be removed entirely. The `PCollection` underlying a side input, is part of the side input's specification with a `ParDo` transform, which will obtain that information via a package-private channel.
org.apache.beam.sdk.transforms.View.CreatePCollectionView.getView() This should not be used to obtain the output of any given application of this `PTransform`. That should be obtained by inspecting the `TransformHierarchy.Node` that contains this `View.CreatePCollectionView`, as this view may have been replaced within pipeline surgery.
org.apache.beam.sdk.values.PCollectionView.getViewFn() this method will be removed entirely. The `ViewFn` for a side input is an attribute of the side input's specification with a `ParDo` transform, which will obtain this specification via a package-private channel.
org.apache.beam.sdk.values.PCollectionView.getWindowingStrategyInternal() this method will be removed entirely. The `PCollection` underlying a side input, including its `WindowingStrategy`, is part of the side input's specification with a `ParDo` transform, which will obtain that information via a package-private channel.
org.apache.beam.sdk.testing.PAssert.PCollectionContentsAssert.hashCode() `Object.hashCode()` is not supported on PAssert objects.
org.apache.beam.sdk.transforms.windowing.WindowFn.isCompatible(WindowFn<?, ?>) please override verifyCompatibility to throw a useful error message; we will remove isCompatible at version 3.0.0
org.apache.beam.sdk.metrics.MetricName.name() to be removed once Dataflow no longer requires this method.
org.apache.beam.sdk.metrics.MetricName.namespace() to be removed once Dataflow no longer requires this method.
org.apache.beam.sdk.transforms.DoFnTester.of(DoFn<InputT, OutputT>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.peekOutputElements() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.peekOutputElements(TupleTag<T>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.peekOutputElementsInWindow(BoundedWindow) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.peekOutputElementsInWindow(TupleTag<OutputT>, BoundedWindow) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.peekOutputElementsWithTimestamp() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFn.prepareForProcessing() use `DoFn.Setup` or `DoFn.StartBundle` instead. This method will be removed in a future release.
org.apache.beam.sdk.transforms.DoFnTester.processBundle(InputT...) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.processBundle(Iterable<? extends InputT>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.processElement(InputT) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.processTimestampedElement(TimestampedValue<InputT>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.processWindowedElement(InputT, Instant, BoundedWindow) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.read() Use `BigQueryIO.read(SerializableFunction)` or `BigQueryIO.readTableRows()` instead. `BigQueryIO.readTableRows()` does exactly the same as `BigQueryIO.read()`, however `BigQueryIO.read(SerializableFunction)` performs better.
org.apache.beam.sdk.transforms.DoFnTester.setCloningBehavior(DoFnTester.CloningBehavior) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.Pipeline.setCoderRegistry(CoderRegistry) this should never be used - every `Pipeline` has a registry throughout its lifetime.
org.apache.beam.sdk.transforms.DoFnTester.setSideInput(PCollectionView<T>, BoundedWindow, T) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.setSideInputs(Map<PCollectionView<?>, Map<BoundedWindow, ?>>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.startBundle() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.takeOutputElements() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.takeOutputElements(TupleTag<T>) Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.transforms.DoFnTester.takeOutputElementsWithTimestamp() Use `TestPipeline` with the `DirectRunner`.
org.apache.beam.sdk.io.AvroIO.Write.to(DynamicAvroDestinations<T, ?, T>) Use `FileIO.write()` or `FileIO.writeDynamic()` instead.
org.apache.beam.sdk.io.AvroIO.TypedWrite.to(DynamicAvroDestinations<UserT, NewDestinationT, OutputT>) Use `FileIO.write()` or `FileIO.writeDynamic()` instead.
org.apache.beam.sdk.io.TextIO.Write.to(FileBasedSink.DynamicDestinations<String, ?, String>) Use `FileIO.write()` or `FileIO.writeDynamic()` ()} with `TextIO.sink()` instead.
org.apache.beam.sdk.io.TextIO.TypedWrite.to(FileBasedSink.DynamicDestinations<UserT, NewDestinationT, String>) Use `FileIO.write()` or `FileIO.writeDynamic()` with `TextIO.sink()` instead.
org.apache.beam.sdk.io.TextIO.Write.to(SerializableFunction<String, DefaultFilenamePolicy.Params>, DefaultFilenamePolicy.Params) Use `FileIO.write()` or `FileIO.writeDynamic()` ()} with `TextIO.sink()` instead.
org.apache.beam.sdk.io.TextIO.TypedWrite.to(SerializableFunction<UserT, DefaultFilenamePolicy.Params>, DefaultFilenamePolicy.Params) Use `FileIO.write()` or `FileIO.writeDynamic()` with `TextIO.sink()` instead.
org.apache.beam.sdk.io.CountingSource.unbounded() use `GenerateSequence` instead
org.apache.beam.sdk.io.CountingSource.unboundedWithTimestampFn(SerializableFunction<Long, Instant>) use `GenerateSequence` and call `GenerateSequence.withTimestampFn(SerializableFunction)` instead
org.apache.beam.sdk.options.ValueProviders.updateSerializedOptions(String, Map<String, String>) Use `TestPipeline.newProvider(T)` for testing `ValueProvider` code.
org.apache.beam.sdk.io.CountingSource.upTo(long) use `GenerateSequence` instead
org.apache.beam.sdk.transforms.WithTimestamps.withAllowedTimestampSkew(Duration) This method permits a to elements to be emitted behind the watermark. These elements are considered late, and if behind the `allowed lateness` of a downstream `PCollection` may be silently dropped. See https://issues.apache.org/jira/browse/BEAM-644 for details on a replacement.
org.apache.beam.sdk.io.gcp.bigtable.BigtableIO.Read.withBigtableOptions(BigtableOptions.Builder) will be replaced by bigtable options configurator.
org.apache.beam.sdk.io.gcp.bigtable.BigtableIO.Write.withBigtableOptions(BigtableOptions.Builder) will be replaced by bigtable options configurator.
org.apache.beam.sdk.io.gcp.bigtable.BigtableIO.Read.withBigtableOptions(BigtableOptions) will be replaced by bigtable options configurator.
org.apache.beam.sdk.io.gcp.bigtable.BigtableIO.Write.withBigtableOptions(BigtableOptions) will be replaced by bigtable options configurator.
org.apache.beam.sdk.io.TextIO.Read.withCompressionType(TextIO.CompressionType) Use `TextIO.Read.withCompression(org.apache.beam.sdk.io.Compression)`.
org.apache.beam.sdk.io.TextIO.ReadAll.withCompressionType(TextIO.CompressionType) Use `TextIO.ReadAll.withCompression(org.apache.beam.sdk.io.Compression)`.
org.apache.beam.sdk.io.TFRecordIO.Read.withCompressionType(TFRecordIO.CompressionType) Use `TFRecordIO.Read.withCompression(org.apache.beam.sdk.io.Compression)`.
org.apache.beam.sdk.io.TFRecordIO.Write.withCompressionType(TFRecordIO.CompressionType) use `TFRecordIO.Write.withCompression(org.apache.beam.sdk.io.Compression)`.
org.apache.beam.sdk.io.xml.XmlIO.Read.withCompressionType(XmlIO.Read.CompressionType) use `XmlIO.Read.withCompression(org.apache.beam.sdk.io.Compression)`.
org.apache.beam.sdk.io.TextIO.TypedWrite.withFormatFunction(SerializableFunction<UserT, String>) Use `FileIO.write()` or `FileIO.writeDynamic()` with `TextIO.sink()` instead.
org.apache.beam.sdk.io.FileIO.Write.withIgnoreWindowing() Avoid usage of this method: its effects are complex and it will be removed in future versions of Beam. Right now it exists for compatibility with `WriteFiles`.
org.apache.beam.sdk.transforms.View.AsMap.withSingletonValues() this method simply returns this AsMap unmodified
org.apache.beam.sdk.io.kafka.KafkaIO.Read.withTimestampFn(SerializableFunction<KV<K, V>, Instant>) as of version 2.4. Use `KafkaIO.Read.withTimestampPolicyFactory(TimestampPolicyFactory)` instead.
org.apache.beam.sdk.io.kafka.KafkaIO.Read.withTimestampFn2(SerializableFunction<KafkaRecord<K, V>, Instant>) as of version 2.4. Use `KafkaIO.Read.withTimestampPolicyFactory(TimestampPolicyFactory)` instead.
org.apache.beam.sdk.io.kafka.KafkaIO.Read.withWatermarkFn(SerializableFunction<KV<K, V>, Instant>) as of version 2.4. Use `KafkaIO.Read.withTimestampPolicyFactory(TimestampPolicyFactory)` instead.
org.apache.beam.sdk.io.kafka.KafkaIO.Read.withWatermarkFn2(SerializableFunction<KafkaRecord<K, V>, Instant>) as of version 2.4. Use `KafkaIO.Read.withTimestampPolicyFactory(TimestampPolicyFactory)` instead.

Deprecated Enum Constants
Enum Constant and Description
org.apache.beam.runners.dataflow.options.DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.BASIC use `DataflowPipelineWorkerPoolOptions.AutoscalingAlgorithmType.THROUGHPUT_BASED`.

Deprecated API

Contents