Class PubsubSchemaTransformWriteConfiguration


  • @Experimental
    @DefaultSchema(org.apache.beam.sdk.schemas.AutoValueSchema.class)
    public abstract class PubsubSchemaTransformWriteConfiguration
    extends java.lang.Object
    Configuration for writing to Pub/Sub.

    Internal only: 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.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.lang.String getFormat()
      The expected format of the Pub/Sub message.
      abstract java.lang.String getIdAttribute()
      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.
      abstract java.lang.String getTimestampAttribute()
      When writing to Cloud Pub/Sub where record timestamps are configured as Pub/Sub message attributes, specifies the name of the attribute that contains the timestamp.
      abstract java.lang.String getTopic()
      The topic to which to write Pub/Sub messages.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • PubsubSchemaTransformWriteConfiguration

        public PubsubSchemaTransformWriteConfiguration()
    • Method Detail

      • getTopic

        public abstract java.lang.String getTopic()
        The topic to which to write Pub/Sub messages.

        See PubsubIO.PubsubTopic.fromPath(String) for more details on the format of the topic string.

      • getFormat

        @Nullable
        public abstract java.lang.String getFormat()
        The expected format of the Pub/Sub message.

        Used to retrieve the PayloadSerializer from PayloadSerializers.

      • getTimestampAttribute

        @Nullable
        public abstract java.lang.String getTimestampAttribute()
        When writing to Cloud Pub/Sub where record timestamps are configured as Pub/Sub message attributes, specifies the name of the attribute that contains the timestamp.
      • getIdAttribute

        @Nullable
        public abstract java.lang.String getIdAttribute()
        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.