Package software.amazon.awssdk.crt.mqtt5.packets

Class UnsubscribePacket

java.lang.Object

software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket

public class UnsubscribePacket
extends Object

Data model of an MQTT5 UNSUBSCRIBE packet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UnsubscribePacket.UnsubscribePacketBuilder	A class to that allows for the creation of a UnsubscribePacket.

Method Summary

Modifier and Type	Method	Description
List<String>	getSubscriptions()	Returns a list of subscriptions that the client wishes to unsubscribe from.
List<UserProperty>	getUserProperties()	Returns a list of MQTT5 user properties included with the packet.
static UnsubscribePacket	of(String topicFilter)	Creates an UnsubscribePacket containing only a single subscription topic to unsubscribe from: topicFilter.

Methods inherited from class java.lang.Object

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

Method Details

of

public static UnsubscribePacket of(String topicFilter)

Creates an UnsubscribePacket containing only a single subscription topic to unsubscribe from: topicFilter.

Internally this is just syntactic sugar around UnsubscribePacketBuilder(String) followed by UnsubscribePacket.UnsubscribePacketBuilder.build().

Parameters:

topicFilter - The topic filter to unsubscribe from.

Returns:

an immutable UnsubscribePacket ready for use

Throws:

NullPointerException - if topicFilter is null

getSubscriptions

public List<String> getSubscriptions()

Returns a list of subscriptions that the client wishes to unsubscribe from.

Returns:

List of subscriptions that the client wishes to unsubscribe from.

getUserProperties

public List<UserProperty> getUserProperties()

Returns a list of MQTT5 user properties included with the packet. See MQTT5 User Property

Returns:

List of MQTT5 user properties included with the packet.