org.apache.beam.sdk.io.mqtt

Class MqttIO.ConnectionConfiguration

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

MqttIO

public abstract static class MqttIO.ConnectionConfiguration
extends java.lang.Object
implements java.io.Serializable

A POJO describing a MQTT connection.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectionConfiguration()

Method Summary

Modifier and Type	Method and Description
static MqttIO.ConnectionConfiguration	create(java.lang.String serverUri, java.lang.String topic) Describe a connection configuration to the MQTT broker.
static MqttIO.ConnectionConfiguration	create(java.lang.String serverUri, java.lang.String topic, java.lang.String clientId) Describe a connection configuration to the MQTT broker.
MqttIO.ConnectionConfiguration	withPassword(java.lang.String password)
MqttIO.ConnectionConfiguration	withUsername(java.lang.String username)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionConfiguration

public ConnectionConfiguration()

Method Detail

create

public static MqttIO.ConnectionConfiguration create(java.lang.String serverUri,
                                                    java.lang.String topic)

Describe a connection configuration to the MQTT broker. This method creates an unique random MQTT client ID.

Parameters:

serverUri - The MQTT broker URI.

topic - The MQTT getTopic pattern.

Returns:

A connection configuration to the MQTT broker.

create

public static MqttIO.ConnectionConfiguration create(java.lang.String serverUri,
                                                    java.lang.String topic,
                                                    java.lang.String clientId)

Describe a connection configuration to the MQTT broker.

Parameters:

serverUri - The MQTT broker URI.

topic - The MQTT getTopic pattern.

clientId - A client ID prefix, used to construct an unique client ID.

Returns:

A connection configuration to the MQTT broker.

withUsername

public MqttIO.ConnectionConfiguration withUsername(java.lang.String username)

withPassword

public MqttIO.ConnectionConfiguration withPassword(java.lang.String password)