[
https://issues.apache.org/jira/browse/BEAM-14036?focusedWorklogId=777851&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-777851
]
ASF GitHub Bot logged work on BEAM-14036:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 02/Jun/22 21:47
Start Date: 02/Jun/22 21:47
Worklog Time Spent: 10m
Work Description: damondouglas commented on code in PR #17730:
URL: https://github.com/apache/beam/pull/17730#discussion_r888439061
##########
sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/pubsub/PubsubSchemaTransformReadConfiguration.java:
##########
@@ -0,0 +1,159 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.sdk.io.gcp.pubsub;
+
+import com.google.auto.value.AutoValue;
+import javax.annotation.Nullable;
+import org.apache.beam.sdk.schemas.AutoValueSchema;
+import org.apache.beam.sdk.schemas.Schema;
+import org.apache.beam.sdk.schemas.annotations.DefaultSchema;
+
+/**
+ * Configuration for reading from Pub/Sub.
+ *
+ * <p><b>Internal only:</b> This class is actively being worked on, and it
will likely change. We
+ * provide no backwards compatibility guarantees, and it should not be
implemented outside the Beam
+ * repository.
+ */
+@SuppressWarnings({
+ "nullness" // TODO(https://issues.apache.org/jira/browse/BEAM-10402)
+})
+@DefaultSchema(AutoValueSchema.class)
+@AutoValue
+public abstract class PubsubSchemaTransformReadConfiguration {
+
+ /** Instantiates a {@link PubsubSchemaTransformReadConfiguration.Builder}. */
+ public static Builder builder() {
+ return new AutoValue_PubsubSchemaTransformReadConfiguration.Builder();
+ }
+
+ /** The expected schema of the Pub/Sub message. */
+ public abstract Schema getDataSchema();
+
+ /**
+ * The Pub/Sub topic path to write failures.
+ *
+ * <p>See {@link PubsubIO.PubsubTopic#fromPath(String)} for more details on
the format of the dead
+ * letter queue topic string.
+ */
+ @Nullable
+ public abstract String getDeadLetterQueue();
Review Comment:
@chamikaramj Thank you again for reviewing. May we consider leaving the
name `getDeadLetterQueue`?
In a previous use of AutoValueSchema with AutoValue in a different project,
I observed it needed the getters to be named as get<property name in camel
case> in order for the serialization to work. For example, I had a property
called fooName. When I named the getter fooName(), the return value of
fooName() was null when invoked in the context of a DoFn. However, when I
changed the getter to getFooName() the return value was what I expected. I am
not sure if my observation is still valid.
Adding to supporting get instead of with, the design goals of the
configuration class are to hold data needed by its corresponding
SchemaProvider. The method is not doing any action implied by the with
preposition. The getter is simply getting data.
Issue Time Tracking
-------------------
Worklog Id: (was: 777851)
Time Spent: 4h (was: 3h 50m)
> Convert Pub/Sub Schema IO to SchemaTransform
> --------------------------------------------
>
> Key: BEAM-14036
> URL: https://issues.apache.org/jira/browse/BEAM-14036
> Project: Beam
> Issue Type: Sub-task
> Components: sdk-java-core
> Reporter: Lara Schmidt
> Assignee: Damon Douglas
> Priority: P2
> Time Spent: 4h
> Remaining Estimate: 0h
>
> The output of this task is to refactor
> [sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/pubsub/PubsubSchemaIOProvider.java|https://github.com/apache/beam/blob/3c62cc906f487d7cd93430bf35d6ac2cd4cc6d3c/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/pubsub/PubsubSchemaIOProvider.java]
> to extend
> [TypedSchemaTransformProvider|https://github.com/apache/beam/blob/master/sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.java].
> This task will be separated into *+four+* PRs to focus on Read and Write
> SchemaTransforms and their respective Configurations. See
> [BigQuerySchemaTransformReadProvider|https://github.com/apache/beam/blob/master/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQuerySchemaTransformReadProvider.java]
> and
> [BigQuerySchemaTransformWriteConfiguration|https://github.com/apache/beam/blob/master/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQuerySchemaTransformWriteConfiguration.java]
> as an example design pattern.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
