org.apache.beam.sdk.io.mqtt

Class MqttIO.Write

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

MqttIO

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

A PTransform to write and send a message to a MQTT server.

See Also:

Serialized Form

Field Summary

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

name

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PDone	expand(org.apache.beam.sdk.values.PCollection<byte[]> input)
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
MqttIO.Write	withConnectionConfiguration(MqttIO.ConnectionConfiguration configuration) Define MQTT connection configuration used to connect to the MQTT broker.
MqttIO.Write	withRetained(boolean retained) Whether or not the publish message should be retained by the messaging engine.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

withConnectionConfiguration

public MqttIO.Write withConnectionConfiguration(MqttIO.ConnectionConfiguration configuration)

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

withRetained

public MqttIO.Write withRetained(boolean retained)

Whether or not the publish message should be retained by the messaging engine. Sending a message with the retained set to false will clear the retained message from the server. The default value is false. When a subscriber connects, it gets the latest retained message (else it doesn't get any existing message, it will have to wait a new incoming message).

Parameters:

retained - Whether or not the messaging engine should retain the message.

Returns:

The MqttIO.Write PTransform with the corresponding retained configuration.

expand

public org.apache.beam.sdk.values.PDone expand(org.apache.beam.sdk.values.PCollection<byte[]> input)

Specified by:

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

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.PCollection<byte[]>,org.apache.beam.sdk.values.PDone>