Package com.hivemq.client.mqtt.mqtt5.message.subscribe

Interface Mqtt5SubscriptionBuilderBase.Complete<C extends Mqtt5SubscriptionBuilderBase.Complete<C>>

Type Parameters:

C - the type of the complete builder.

All Superinterfaces:

Mqtt5SubscriptionBuilderBase<C>

All Known Subinterfaces:

Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder.Start.Complete, Mqtt5SubscribeBuilder.Nested.Start.Complete<P>, Mqtt5SubscribeBuilder.Publishes.Start.Complete<P>, Mqtt5SubscribeBuilder.Send.Start.Complete<P>, Mqtt5SubscribeBuilder.Start.Complete, Mqtt5SubscribeBuilderBase.Start.Complete<C,SC>, Mqtt5SubscriptionBuilder.Complete, Mqtt5SubscriptionBuilder.Nested.Complete<P>

Enclosing interface:

Mqtt5SubscriptionBuilderBase<C extends Mqtt5SubscriptionBuilderBase.Complete<C>>

@DoNotImplement
public static interface Mqtt5SubscriptionBuilderBase.Complete<C extends Mqtt5SubscriptionBuilderBase.Complete<C>>
extends Mqtt5SubscriptionBuilderBase<C>

Mqtt5SubscriptionBuilderBase that is complete which means all mandatory fields are set.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5SubscriptionBuilderBase

Mqtt5SubscriptionBuilderBase.Complete<C extends Mqtt5SubscriptionBuilderBase.Complete<C>>

Method Summary

Modifier and Type	Method	Description
C	noLocal(boolean noLocal)	Sets whether the subscription is not local.
C	qos(@NotNull MqttQos qos)	Sets the QoS.
C	retainAsPublished(boolean retainAsPublished)	Sets whether the Publish messages for the subscription are published with the retain flag.
C	retainHandling(@NotNull Mqtt5RetainHandling retainHandling)	Sets the retain handling.

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5SubscriptionBuilderBase

topicFilter, topicFilter, topicFilter

Method Details

qos

@CheckReturnValue
@NotNull
C qos(@NotNull
 @NotNull MqttQos qos)

Sets the QoS.

Parameters:

qos - the QoS.

Returns:

the builder.

noLocal

@CheckReturnValue
@NotNull
C noLocal(boolean noLocal)

Sets whether the subscription is not local.

Parameters:

noLocal - whether the subscription is not local.

Returns:

the builder.

retainHandling

@CheckReturnValue
@NotNull
C retainHandling(@NotNull
 @NotNull Mqtt5RetainHandling retainHandling)

Sets the retain handling.

Parameters:

retainHandling - the retain handling.

Returns:

the builder.

retainAsPublished

@CheckReturnValue
@NotNull
C retainAsPublished(boolean retainAsPublished)

Sets whether the Publish messages for the subscription are published with the retain flag.

Parameters:

retainAsPublished - whether the Publish messages for the subscription are published with the retain flag.

Returns:

the builder.