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

Class SubscribePacket.Subscription

java.lang.Object
software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription
Enclosing class:
SubscribePacket
public static final class SubscribePacket.Subscription extends Object
Configures a single subscription within a Subscribe operation See MQTT5 Subscription Options

  • Method Details

    • getTopicFilter

      public String getTopicFilter()
      Returns the topic filter to subscribe to See MQTT5 Subscription Options
      Returns:
      The topic filter to subscribe to

    • getQOS

      public QOS getQOS()
      Returns the maximum QoS on which the subscriber will accept publish messages. Negotiated QoS may be different. See MQTT5 Subscription Options
      Returns:
      The maximum QoS on which the subscriber will accept publish messages

    • getNoLocal

      public Boolean getNoLocal()
      Returns whether the server should not send publishes to a client when that client was the one who sent the publish. If null, this is assumed to be false. See MQTT5 Subscription Options
      Returns:
      Whether the server will not send publishes to a client when that client was the one who sent the publish

    • getRetainAsPublished

      public Boolean getRetainAsPublished()
      Returns whether messages sent due to this subscription keep the retain flag preserved on the message. If null, this is assumed to be false. See MQTT5 Subscription Options
      Returns:
      Whether messages sent due to this subscription keep the retain flag preserved on the message

    • getRetainHandlingType

      public SubscribePacket.RetainHandlingType getRetainHandlingType()
      Returns whether retained messages on matching topics be sent in reaction to this subscription. If null, this is assumed to be RetainHandlingType.SendOnSubscribe. See MQTT5 Subscription Options
      Returns:
      Whether retained messages on matching topics be sent in reaction to this subscription