public abstract static class MqttIO.Read<T> extends PTransform<PBegin,PCollection<T>>
PTransform
to read from a MQTT broker.annotations, displayData, name, resourceHints
Constructor and Description |
---|
Read() |
Modifier and Type | Method and Description |
---|---|
PCollection<T> |
expand(PBegin input)
Override this method to specify how this
PTransform should be expanded on the given
InputT . |
void |
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.
|
MqttIO.Read<T> |
withConnectionConfiguration(MqttIO.ConnectionConfiguration configuration)
Define the MQTT connection configuration used to connect to the MQTT broker.
|
MqttIO.Read<T> |
withMaxNumRecords(long maxNumRecords)
Define the max number of records received by the
MqttIO.Read . |
MqttIO.Read<T> |
withMaxReadTime(Duration maxReadTime)
Define the max read time (duration) while the
MqttIO.Read will receive messages. |
addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, setResourceHints, toString, validate, validate
public MqttIO.Read<T> withConnectionConfiguration(MqttIO.ConnectionConfiguration configuration)
public MqttIO.Read<T> withMaxNumRecords(long maxNumRecords)
MqttIO.Read
. When this max number of
records is lower than Long.MAX_VALUE
, the MqttIO.Read
will provide a bounded PCollection
.public MqttIO.Read<T> withMaxReadTime(Duration maxReadTime)
MqttIO.Read
will receive messages. When this
max read time is not null, the MqttIO.Read
will provide a bounded PCollection
.public PCollection<T> expand(PBegin input)
PTransform
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).
expand
in class PTransform<PBegin,PCollection<T>>
public void populateDisplayData(DisplayData.Builder builder)
PTransform
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.
populateDisplayData
in interface HasDisplayData
populateDisplayData
in class PTransform<PBegin,PCollection<T>>
builder
- The builder to populate with display data.HasDisplayData