You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by da...@apache.org on 2024/08/28 12:50:16 UTC

(beam) branch users/damccorm/pulsar created (now 523f999d31f)

This is an automated email from the ASF dual-hosted git repository.

damccorm pushed a change to branch users/damccorm/pulsar
in repository https://gitbox.apache.org/repos/asf/beam.git


      at 523f999d31f Add quality warnings to pulsar

This branch includes the following new commits:

     new 523f999d31f Add quality warnings to pulsar

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(beam) 01/01: Add quality warnings to pulsar

Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

damccorm pushed a commit to branch users/damccorm/pulsar
in repository https://gitbox.apache.org/repos/asf/beam.git

commit 523f999d31f240c6e9418b53a756e62b252ccfea
Author: Danny McCormick <da...@google.com>
AuthorDate: Wed Aug 28 13:50:00 2024 +0100

    Add quality warnings to pulsar
---
 .../main/java/org/apache/beam/sdk/io/pulsar/PulsarIO.java | 15 +++++++++++++++
 .../org/apache/beam/sdk/io/pulsar/ReadFromPulsarDoFn.java |  5 +++++
 .../org/apache/beam/sdk/io/pulsar/WriteToPulsarDoFn.java  |  5 +++++
 .../java/org/apache/beam/sdk/io/pulsar/package-info.java  |  6 +++++-
 4 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/PulsarIO.java b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/PulsarIO.java
index 6d0f0a08a01..e5cde0aec01 100644
--- a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/PulsarIO.java
+++ b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/PulsarIO.java
@@ -31,12 +31,22 @@ import org.apache.pulsar.client.api.PulsarClient;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.joda.time.Instant;
 
+/** Class for reading and writing from Apache Pulsar. Support is
+ * currently incomplete, and there may be bugs; see
+ * https://github.com/apache/beam/issues/31078 for more info, and comment
+ * in that issue if you run into issues with this IO.
+*/
 @SuppressWarnings({"rawtypes", "nullness"})
 public class PulsarIO {
 
   /** Static class, prevent instantiation. */
   private PulsarIO() {}
 
+  /** Read from Apache Pulsar. Support is currently incomplete, and there may
+   * be bugs; see
+   * https://github.com/apache/beam/issues/31078 for more info, and comment
+   * in that issue if you run into issues with this IO.
+  */
   public static Read read() {
     return new AutoValue_PulsarIO_Read.Builder()
         .setPulsarClient(PulsarIOUtils.PULSAR_CLIENT_SERIALIZABLE_FUNCTION)
@@ -144,6 +154,11 @@ public class PulsarIO {
     }
   }
 
+  /** Write to Apache Pulsar. Support is currently incomplete, and there may
+   * be bugs; see
+   * https://github.com/apache/beam/issues/31078 for more info, and comment
+   * in that issue if you run into issues with this IO.
+  */
   public static Write write() {
     return new AutoValue_PulsarIO_Write.Builder().build();
   }
diff --git a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/ReadFromPulsarDoFn.java b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/ReadFromPulsarDoFn.java
index 97a8dcd6e2b..14ca4b4d5b6 100644
--- a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/ReadFromPulsarDoFn.java
+++ b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/ReadFromPulsarDoFn.java
@@ -43,6 +43,11 @@ import org.joda.time.Instant;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/** Transform for reading from Apache Pulsar. Support is
+ * currently incomplete, and there may be bugs; see
+ * https://github.com/apache/beam/issues/31078 for more info, and comment
+ * in that issue if you run into issues with this IO.
+*/
 @DoFn.UnboundedPerElement
 @SuppressWarnings({"rawtypes", "nullness"})
 public class ReadFromPulsarDoFn extends DoFn<PulsarSourceDescriptor, PulsarMessage> {
diff --git a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/WriteToPulsarDoFn.java b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/WriteToPulsarDoFn.java
index 9659940e02b..3199bf792bd 100644
--- a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/WriteToPulsarDoFn.java
+++ b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/WriteToPulsarDoFn.java
@@ -23,6 +23,11 @@ import org.apache.pulsar.client.api.Producer;
 import org.apache.pulsar.client.api.PulsarClient;
 import org.apache.pulsar.client.api.PulsarClientException;
 
+/** Transform for writing to Apache Pulsar. Support is
+ * currently incomplete, and there may be bugs; see
+ * https://github.com/apache/beam/issues/31078 for more info, and comment
+ * in that issue if you run into issues with this IO.
+*/
 @DoFn.UnboundedPerElement
 @SuppressWarnings({"rawtypes", "nullness"})
 public class WriteToPulsarDoFn extends DoFn<byte[], Void> {
diff --git a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/package-info.java b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/package-info.java
index 8b7ab101a72..27effe2e077 100644
--- a/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/package-info.java
+++ b/sdks/java/io/pulsar/src/main/java/org/apache/beam/sdk/io/pulsar/package-info.java
@@ -15,5 +15,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** Transforms for reading and writing from Apache Pulsar. */
+/** Transforms for reading and writing from Apache Pulsar. Support is
+ * currently incomplete, and there may be bugs; see
+ * https://github.com/apache/beam/issues/31078 for more info, and comment
+ * in that issue if you run into issues with this IO.
+*/
 package org.apache.beam.sdk.io.pulsar;