Class SubscribePacket
- java.lang.Object
-
- software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket
-
public class SubscribePacket extends Object
Data model of an MQTT5 SUBSCRIBE packet.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubscribePacket.RetainHandlingTypeConfigures how retained messages should be handled when subscribing with a subscription that matches topics with associated retained messages.static classSubscribePacket.SubscribePacketBuilderA class to that allows for the creation of a SubscribePacket.static classSubscribePacket.SubscriptionConfigures a single subscription within a Subscribe operation See MQTT5 Subscription Options
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LonggetSubscriptionIdentifier()Returns the positive long to associate with all subscriptions in this request.List<SubscribePacket.Subscription>getSubscriptions()Returns the list of subscriptions that the client wishes to listen to See MQTT5 Subscribe PayloadList<UserProperty>getUserProperties()Returns the list of MQTT5 user properties included with the packet.
-
-
-
Method Detail
-
getSubscriptions
public List<SubscribePacket.Subscription> getSubscriptions()
Returns the list of subscriptions that the client wishes to listen to See MQTT5 Subscribe Payload- Returns:
- List of subscriptions that the client wishes to listen to
-
getSubscriptionIdentifier
public Long getSubscriptionIdentifier()
Returns the positive long to associate with all subscriptions in this request. Publish packets that match a subscription in this request should include this identifier in the resulting message. See MQTT5 Subscription Identifier- Returns:
- A positive long to associate with all subscriptions in this request.
-
getUserProperties
public List<UserProperty> getUserProperties()
Returns the list of MQTT5 user properties included with the packet. See MQTT5 User Property- Returns:
- List of MQTT5 user properties included with the packet.
-
-