org.apache.beam.sdk.io.mqtt

Class MqttIO.Read

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

MqttIO

public abstract static class MqttIO.Read
extends PTransform<PBegin,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

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
PCollection<byte[]>	expand(PBegin input) Applies this PTransform on the given InputT, and returns its Output.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
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(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

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString

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(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<byte[]> expand(PBegin input)

Description copied from class: PTransform

Applies this PTransform on the given InputT, and returns its Output.

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<byte[]>>

validate

public void validate(PipelineOptions options)

Description copied from class: PTransform

Called before running the Pipeline to verify this transform is fully and correctly specified.

By default, does nothing.

Overrides:

validate in class PTransform<PBegin,PCollection<byte[]>>

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<byte[]>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData