add deprecation note

Signed-off-by: Jeffrey Kinard <[email protected]>
apache · Dec 4, 2024 · 9219a49 · 9219a49
1 parent f5102b4
commit 9219a49
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/...ain/java/org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteReadSchemaTransformProvider.java b/...ain/java/org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteReadSchemaTransformProvider.java
@@ -87,6 +87,13 @@ protected Class<PubsubLiteReadSchemaTransformConfiguration> configurationClass()
     return PubsubLiteReadSchemaTransformConfiguration.class;
   }
 
+  @Override
+  public String description() {
+    return "Performs a read from Google Pub/Sub Lite.\n"
+        + "\n"
+        + "**Note**: This provider is deprecated. See Pub/Sub Lite <a href=\"https://cloud.google.com/pubsub/lite/docs\">documentation</a> for more information.";
+  }
+
   public static class ErrorFn extends DoFn<SequencedMessage, Row> {
     private final SerializableFunction<byte[], Row> valueMapper;
     private final Counter errorCounter;

diff --git a/...in/java/org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteWriteSchemaTransformProvider.java b/...in/java/org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteWriteSchemaTransformProvider.java
@@ -82,6 +82,13 @@ protected Class<PubsubLiteWriteSchemaTransformConfiguration> configurationClass(
     return PubsubLiteWriteSchemaTransformConfiguration.class;
   }
 
+  @Override
+  public String description() {
+    return "Performs a write to Google Pub/Sub Lite.\n"
+        + "\n"
+        + "**Note**: This provider is deprecated. See Pub/Sub Lite <a href=\"https://cloud.google.com/pubsub/lite/docs\">documentation</a> for more information.";
+  }
+
   public static class ErrorCounterFn extends DoFn<Row, PubSubMessage> {
     private final SerializableFunction<Row, byte[]> toBytesFn;
     private final Counter errorCounter;

diff --git a/sdks/python/apache_beam/yaml/generate_yaml_docs.py b/sdks/python/apache_beam/yaml/generate_yaml_docs.py
@@ -189,11 +189,8 @@ def io_grouping_key(transform_name):
     return 0, transform_name
 
 
-# Deprecated providers
-SKIP = {
-    'ReadFromPubSubLite',
-    'WriteToPubSubLite',
-}
+# Exclude providers
+SKIP = {}
 
 
 def transform_docs(transform_base, transforms, providers, extra_docs=''):