org.apache.beam.sdk.io.mqtt

Class MqttIO.Read

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<byte[]>>

org.apache.beam.sdk.io.mqtt.MqttIO.Read

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

MqttIO

public abstract static class MqttIO.Read
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<byte[]>>

A PTransform to read from a MQTT broker.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<byte[]>	expand(org.apache.beam.sdk.values.PBegin input)
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
MqttIO.Read	withConnectionConfiguration(MqttIO.ConnectionConfiguration configuration) Define the MQTT connection configuration used to connect to the MQTT broker.
MqttIO.Read	withMaxNumRecords(long maxNumRecords) Define the max number of records received by the MqttIO.Read.
MqttIO.Read	withMaxReadTime(org.joda.time.Duration maxReadTime) Define the max read time (duration) while the MqttIO.Read will receive messages.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Read

public Read()

Method Detail

withConnectionConfiguration

public MqttIO.Read withConnectionConfiguration(MqttIO.ConnectionConfiguration configuration)

Define the MQTT connection configuration used to connect to the MQTT broker.

withMaxNumRecords

public MqttIO.Read 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 withMaxReadTime(org.joda.time.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 org.apache.beam.sdk.values.PCollection<byte[]> expand(org.apache.beam.sdk.values.PBegin input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<byte[]>>

populateDisplayData

public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)

Specified by:

populateDisplayData in interface org.apache.beam.sdk.transforms.display.HasDisplayData

Overrides:

populateDisplayData in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<byte[]>>