pabloem commented on code in PR #24443: URL: https://github.com/apache/beam/pull/24443#discussion_r1050158500
########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.java: ########## @@ -0,0 +1,205 @@ +/* + * 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.annotations.Experimental; +import org.apache.beam.sdk.schemas.AutoValueSchema; +import org.apache.beam.sdk.schemas.annotations.DefaultSchema; + +/** + * Configuration for writing to 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. + */ +@Experimental +@DefaultSchema(AutoValueSchema.class) +@AutoValue +public abstract class PubsubWriteSchemaTransformConfiguration { + + public static final String DEFAULT_TIMESTAMP_ATTRIBUTE = "event_timestamp"; + + public static Builder builder() { + return new AutoValue_PubsubWriteSchemaTransformConfiguration.Builder(); + } + + public static TargetConfiguration.Builder targetConfigurationBuilder() { + return new AutoValue_PubsubWriteSchemaTransformConfiguration_TargetConfiguration.Builder() + .setTimestampAttributeKey(DEFAULT_TIMESTAMP_ATTRIBUTE); + } + + public static SourceConfiguration.Builder sourceConfigurationBuilder() { + return new AutoValue_PubsubWriteSchemaTransformConfiguration_SourceConfiguration.Builder(); + } + + /** + * Configuration details of the source {@link org.apache.beam.sdk.values.Row} {@link + * org.apache.beam.sdk.schemas.Schema}. + */ + @Nullable + public abstract SourceConfiguration getSource(); + + /** Configuration details of the target {@link PubsubMessage}. */ + public abstract TargetConfiguration getTarget(); + + /** + * The topic to which to write Pub/Sub messages. + * + * <p>See {@link PubsubIO.PubsubTopic#fromPath(String)} for more details on the format of the + * topic string. + */ + public abstract String getTopic(); + + /** + * The expected format of the Pub/Sub message. + * + * <p>Used to retrieve the {@link org.apache.beam.sdk.schemas.io.payloads.PayloadSerializer} from + * {@link org.apache.beam.sdk.schemas.io.payloads.PayloadSerializers}. + */ + @Nullable + public abstract String getFormat(); + + /** + * When writing to Cloud Pub/Sub where unique record identifiers are provided as Pub/Sub message + * attributes, specifies the name of the attribute containing the unique identifier. + */ + @Nullable + public abstract String getIdAttribute(); + + /** Builder for {@link PubsubWriteSchemaTransformConfiguration}. */ + @AutoValue.Builder + public abstract static class Builder { + + /** + * Configuration details of the source {@link org.apache.beam.sdk.values.Row} {@link + * org.apache.beam.sdk.schemas.Schema}. + */ + public abstract Builder setSource(SourceConfiguration value); + + /** Configuration details of the target {@link PubsubMessage}. */ + public abstract Builder setTarget(TargetConfiguration value); + + /** + * The topic to which to write Pub/Sub messages. + * + * <p>See {@link PubsubIO.PubsubTopic#fromPath(String)} for more details on the format of the + * topic string. + */ + public abstract Builder setTopic(String value); + + /** + * The expected format of the Pub/Sub message. + * + * <p>Used to retrieve the {@link org.apache.beam.sdk.schemas.io.payloads.PayloadSerializer} + * from {@link org.apache.beam.sdk.schemas.io.payloads.PayloadSerializers}. + */ + public abstract Builder setFormat(String value); Review Comment: thanks Damon! perhaps you can list here the formats that are supported? I understand it's anything that's a Payload serializer, but since users may use this without an IDE / writing unit tests, they may not know a priori what those are... wdyt? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
