PubsubIO.Write (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Warning: Dataflow SDK 1.x for Java is unsupported as of October 16, 2018. After August 12, 2020, you can use unsupported SDKs temporarily while you upgrade your pipelines. For more information, see Using an unsupported SDK.

For information on migrating from the 1.x SDK, see Migrating from Dataflow SDK 1.x for Java.

Note: If you are using Cloud Dataflow SDK version 2.x, see the Apache Beam API reference documentation.

com.google.cloud.dataflow.sdk.io

Class PubsubIO.Write

• java.lang.Object
• • com.google.cloud.dataflow.sdk.io.PubsubIO.Write

• Enclosing class:

  PubsubIO

  ---

  
  

  public static class PubsubIO.Write
  extends Object

  A PTransform that continuously writes a PCollection of Strings to a Cloud Pub/Sub stream.

• • Nested Class Summary

    Nested Classes 

    Modifier and Type	Class and Description
    static class	PubsubIO.Write.Bound<T> A PTransform that writes an unbounded PCollection of Strings to a Cloud Pub/Sub stream.

  • Method Summary

    All Methods Static Methods Concrete Methods 

    Modifier and Type	Method and Description
    static PubsubIO.Write.Bound<String>	idLabel(String idLabel) Creates a transform that writes to Pub/Sub, adding each record's unique identifier to the published messages in an attribute with the specified name.
    static PubsubIO.Write.Bound<String>	named(String name) Creates a transform that writes to Pub/Sub with the given step name.
    static PubsubIO.Write.Bound<String>	timestampLabel(String timestampLabel) Creates a transform that writes to Pub/Sub, adds each record's timestamp to the published messages in an attribute with the specified name.
    static PubsubIO.Write.Bound<String>	topic(String topic) Creates a transform that publishes to the specified topic.
    static PubsubIO.Write.Bound<String>	topic(ValueProvider<String> topic) Like topic() but with a ValueProvider.
    static <T> PubsubIO.Write.Bound<T>	withCoder(Coder<T> coder) Creates a transform that uses the given Coder to encode each of the elements of the input collection into an output message.

    • Methods inherited from class java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • Method Detail

    • named

      public static PubsubIO.Write.Bound<String> named(String name)

      Creates a transform that writes to Pub/Sub with the given step name.

    • topic

      public static PubsubIO.Write.Bound<String> topic(String topic)

      Creates a transform that publishes to the specified topic.

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

    • topic

      public static PubsubIO.Write.Bound<String> topic(ValueProvider<String> topic)

      Like topic() but with a ValueProvider.

    • timestampLabel

      public static PubsubIO.Write.Bound<String> timestampLabel(String timestampLabel)

      Creates a transform that writes to Pub/Sub, adds each record's timestamp to the published messages in an attribute with the specified name. The value of the attribute will be a number representing the number of milliseconds since the Unix epoch. For example, if using the Joda time classes, Instant.Instant(long) can be used to parse this value.

      If the output from this sink is being read by another Dataflow source, then PubsubIO.Read.timestampLabel(String) can be used to ensure the other source reads these timestamps from the appropriate attribute.

    • idLabel

      public static PubsubIO.Write.Bound<String> idLabel(String idLabel)

      Creates a transform that writes to Pub/Sub, adding each record's unique identifier to the published messages in an attribute with the specified name. The value of the attribute is an opaque string.

      If the the output from this sink is being read by another Dataflow source, then PubsubIO.Read.idLabel(String) can be used to ensure that* the other source reads these unique identifiers from the appropriate attribute.

    • withCoder

      public static <T> PubsubIO.Write.Bound<T> withCoder(Coder<T> coder)

      Creates a transform that uses the given Coder to encode each of the elements of the input collection into an output message.

      By default, uses StringUtf8Coder, which writes input Java strings directly as records.

      Type Parameters:

      T - the type of the elements of the input PCollection