org.apache.beam.sdk.io.mqtt

Class MqttIO.Write

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

MqttIO

public abstract static class MqttIO.Write
extends PTransform<PCollection<byte[]>,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
PDone	expand(PCollection<byte[]> 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.
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
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

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

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 PDone expand(PCollection<byte[]> 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<PCollection<byte[]>,PDone>

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<PCollection<byte[]>,PDone>

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<PCollection<byte[]>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData