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) Deprecated. This constructor will be removed in a future version of Beam, please use #create(String, String)} and withClientId(String) instead.
MqttIO.ConnectionConfiguration	withClientId(java.lang.String clientId) Set up the client ID prefix, which is used to construct a unique client ID.
MqttIO.ConnectionConfiguration	withPassword(java.lang.String password)
MqttIO.ConnectionConfiguration	withServerUri(java.lang.String serverUri) Set up the MQTT broker URI.
MqttIO.ConnectionConfiguration	withTopic(java.lang.String topic) Set up the MQTT getTopic pattern.
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 a 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

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

Deprecated. This constructor will be removed in a future version of Beam, please use #create(String, String)} and withClientId(String) instead.

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 a unique client ID.

Returns:

A connection configuration to the MQTT broker.

withServerUri

public MqttIO.ConnectionConfiguration withServerUri(java.lang.String serverUri)

Set up the MQTT broker URI.

withTopic

public MqttIO.ConnectionConfiguration withTopic(java.lang.String topic)

Set up the MQTT getTopic pattern.

withClientId

public MqttIO.ConnectionConfiguration withClientId(java.lang.String clientId)

Set up the client ID prefix, which is used to construct a unique client ID.

withUsername

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

withPassword

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