DataflowEndpointMqtt Class

Package:

com.azure.resourcemanager.iotoperations.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-iotoperations:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.iotoperations.models.DataflowEndpointMqtt

Implements

JsonSerializable<DataflowEndpointMqtt>

public final class DataflowEndpointMqtt
implements JsonSerializable<DataflowEndpointMqtt>

Broker endpoint properties.

Constructor Summary

Constructor	Description
DataflowEndpointMqtt()	Creates an instance of DataflowEndpointMqtt class.

Method Summary

Modifier and Type	Method and Description
DataflowEndpointMqttAuthentication	authentication() Get the authentication property: authentication properties.
String	clientIdPrefix() Get the clientIdPrefix property: Client ID prefix.
CloudEventAttributeType	cloudEventAttributes() Get the cloudEventAttributes property: Cloud event mapping config.
static DataflowEndpointMqtt	fromJson(JsonReader jsonReader) Reads an instance of DataflowEndpointMqtt from the JsonReader.
String	host() Get the host property: Host of the Broker in the form of <hostname>:<port>.
Integer	keepAliveSeconds() Get the keepAliveSeconds property: Broker KeepAlive for connection in seconds.
Integer	maxInflightMessages() Get the maxInflightMessages property: The max number of messages to keep in flight.
BrokerProtocolType	protocol() Get the protocol property: Enable or disable websockets.
Integer	qos() Get the qos property: Qos for Broker connection.
MqttRetainType	retain() Get the retain property: Whether or not to keep the retain setting.
Integer	sessionExpirySeconds() Get the sessionExpirySeconds property: Session expiry in seconds.
TlsProperties	tls() Get the tls property: TLS configuration.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
DataflowEndpointMqtt	withAuthentication(DataflowEndpointMqttAuthentication authentication) Set the authentication property: authentication properties.
DataflowEndpointMqtt	withClientIdPrefix(String clientIdPrefix) Set the clientIdPrefix property: Client ID prefix.
DataflowEndpointMqtt	withCloudEventAttributes(CloudEventAttributeType cloudEventAttributes) Set the cloudEventAttributes property: Cloud event mapping config.
DataflowEndpointMqtt	withHost(String host) Set the host property: Host of the Broker in the form of <hostname>:<port>.
DataflowEndpointMqtt	withKeepAliveSeconds(Integer keepAliveSeconds) Set the keepAliveSeconds property: Broker KeepAlive for connection in seconds.
DataflowEndpointMqtt	withMaxInflightMessages(Integer maxInflightMessages) Set the maxInflightMessages property: The max number of messages to keep in flight.
DataflowEndpointMqtt	withProtocol(BrokerProtocolType protocol) Set the protocol property: Enable or disable websockets.
DataflowEndpointMqtt	withQos(Integer qos) Set the qos property: Qos for Broker connection.
DataflowEndpointMqtt	withRetain(MqttRetainType retain) Set the retain property: Whether or not to keep the retain setting.
DataflowEndpointMqtt	withSessionExpirySeconds(Integer sessionExpirySeconds) Set the sessionExpirySeconds property: Session expiry in seconds.
DataflowEndpointMqtt	withTls(TlsProperties tls) Set the tls property: TLS configuration.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataflowEndpointMqtt

public DataflowEndpointMqtt()

Creates an instance of DataflowEndpointMqtt class.

Method Details

authentication

public DataflowEndpointMqttAuthentication authentication()

Get the authentication property: authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed.

Returns:

the authentication value.

clientIdPrefix

public String clientIdPrefix()

Get the clientIdPrefix property: Client ID prefix. Client ID generated by the dataflow is <prefix>-TBD. Optional; no prefix if omitted.

Returns:

the clientIdPrefix value.

cloudEventAttributes

public CloudEventAttributeType cloudEventAttributes()

Get the cloudEventAttributes property: Cloud event mapping config.

Returns:

the cloudEventAttributes value.

fromJson

public static DataflowEndpointMqtt fromJson(JsonReader jsonReader)

Reads an instance of DataflowEndpointMqtt from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DataflowEndpointMqtt if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

host

public String host()

Get the host property: Host of the Broker in the form of <hostname>:<port>. Optional; connects to Broker if omitted.

Returns:

the host value.

keepAliveSeconds

public Integer keepAliveSeconds()

Get the keepAliveSeconds property: Broker KeepAlive for connection in seconds.

Returns:

the keepAliveSeconds value.

maxInflightMessages

public Integer maxInflightMessages()

Get the maxInflightMessages property: The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack.

Returns:

the maxInflightMessages value.

protocol

public BrokerProtocolType protocol()

Get the protocol property: Enable or disable websockets.

Returns:

the protocol value.

qos

public Integer qos()

Get the qos property: Qos for Broker connection.

Returns:

the qos value.

retain

public MqttRetainType retain()

Get the retain property: Whether or not to keep the retain setting.

Returns:

the retain value.

sessionExpirySeconds

public Integer sessionExpirySeconds()

Get the sessionExpirySeconds property: Session expiry in seconds.

Returns:

the sessionExpirySeconds value.

tls

public TlsProperties tls()

Get the tls property: TLS configuration.

Returns:

the tls value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAuthentication

public DataflowEndpointMqtt withAuthentication(DataflowEndpointMqttAuthentication authentication)

Set the authentication property: authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed.

Parameters:

authentication - the authentication value to set.

Returns:

the DataflowEndpointMqtt object itself.

withClientIdPrefix

public DataflowEndpointMqtt withClientIdPrefix(String clientIdPrefix)

Set the clientIdPrefix property: Client ID prefix. Client ID generated by the dataflow is <prefix>-TBD. Optional; no prefix if omitted.

Parameters:

clientIdPrefix - the clientIdPrefix value to set.

Returns:

the DataflowEndpointMqtt object itself.

withCloudEventAttributes

public DataflowEndpointMqtt withCloudEventAttributes(CloudEventAttributeType cloudEventAttributes)

Set the cloudEventAttributes property: Cloud event mapping config.

Parameters:

cloudEventAttributes - the cloudEventAttributes value to set.

Returns:

the DataflowEndpointMqtt object itself.

withHost

public DataflowEndpointMqtt withHost(String host)

Set the host property: Host of the Broker in the form of <hostname>:<port>. Optional; connects to Broker if omitted.

Parameters:

host - the host value to set.

Returns:

the DataflowEndpointMqtt object itself.

withKeepAliveSeconds

public DataflowEndpointMqtt withKeepAliveSeconds(Integer keepAliveSeconds)

Set the keepAliveSeconds property: Broker KeepAlive for connection in seconds.

Parameters:

keepAliveSeconds - the keepAliveSeconds value to set.

Returns:

the DataflowEndpointMqtt object itself.

withMaxInflightMessages

public DataflowEndpointMqtt withMaxInflightMessages(Integer maxInflightMessages)

Set the maxInflightMessages property: The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack.

Parameters:

maxInflightMessages - the maxInflightMessages value to set.

Returns:

the DataflowEndpointMqtt object itself.

withProtocol

public DataflowEndpointMqtt withProtocol(BrokerProtocolType protocol)

Set the protocol property: Enable or disable websockets.

Parameters:

protocol - the protocol value to set.

Returns:

the DataflowEndpointMqtt object itself.

withQos

public DataflowEndpointMqtt withQos(Integer qos)

Set the qos property: Qos for Broker connection.

Parameters:

qos - the qos value to set.

Returns:

the DataflowEndpointMqtt object itself.

withRetain

public DataflowEndpointMqtt withRetain(MqttRetainType retain)

Set the retain property: Whether or not to keep the retain setting.

Parameters:

retain - the retain value to set.

Returns:

the DataflowEndpointMqtt object itself.

withSessionExpirySeconds

public DataflowEndpointMqtt withSessionExpirySeconds(Integer sessionExpirySeconds)

Set the sessionExpirySeconds property: Session expiry in seconds.

Parameters:

sessionExpirySeconds - the sessionExpirySeconds value to set.

Returns:

the DataflowEndpointMqtt object itself.

withTls

public DataflowEndpointMqtt withTls(TlsProperties tls)

Set the tls property: TLS configuration.

Parameters:

tls - the tls value to set.

Returns:

the DataflowEndpointMqtt object itself.