Package org.apache.beam.sdk.io.mqtt

Class MqttIO.Read<T>

java.lang.Object
org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<T>>
org.apache.beam.sdk.io.mqtt.MqttIO.Read<T>
All Implemented Interfaces:
Serializable, HasDisplayData
Enclosing class:
MqttIO
public abstract static class MqttIO.Read<T> extends PTransform<PBegin,PCollection<T>>
A PTransform to read from a MQTT broker.
See Also:

  • Constructor Details

    • Read

      public Read()

  • Method Details

    • withConnectionConfiguration

      public MqttIO.Read<T> withConnectionConfiguration(MqttIO.ConnectionConfiguration configuration)
      Define the MQTT connection configuration used to connect to the MQTT broker.

    • withMaxNumRecords

      public MqttIO.Read<T> withMaxNumRecords(long maxNumRecords)
      Define the max number of records received by the MqttIO.Read. When this max number of records is lower than Long.MAX_VALUE, the MqttIO.Read will provide a bounded PCollection.

    • withMaxReadTime

      public MqttIO.Read<T> withMaxReadTime(Duration maxReadTime)
      Define the max read time (duration) while the MqttIO.Read will receive messages. When this max read time is not null, the MqttIO.Read will provide a bounded PCollection.

    • expand

      public PCollection<T> expand(PBegin input)
      Description copied from class: PTransform
      Override this method to specify how this PTransform should be expanded on the given InputT.

      NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

      Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

      Specified by:
      expand in class PTransform<PBegin,PCollection<T>>

    • populateDisplayData

      public void populateDisplayData(DisplayData.Builder builder)
      Description copied from class: PTransform
      Register display data for the given transform or component.

      populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

      By default, does not register any display data. Implementors may override this method to provide their own display data.

      Specified by:
      populateDisplayData in interface HasDisplayData
      Overrides:
      populateDisplayData in class PTransform<PBegin,PCollection<T>>
      Parameters:
      builder - The builder to populate with display data.
      See Also: