Package com.hivemq.client.mqtt.mqtt5.message.publish.puback

Interface Mqtt5PubAckBuilder

@DoNotImplement
public interface Mqtt5PubAckBuilder

Builder for a Mqtt5PubAck.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt5PubAckBuilder	reasonCode(@NotNull Mqtt5PubAckReasonCode reasonCode)	Sets the Reason Code.
@NotNull Mqtt5PubAckBuilder	reasonString(@Nullable MqttUtf8String reasonString)	Set the optional Reason String.
@NotNull Mqtt5PubAckBuilder	reasonString(@Nullable String reasonString)	Set the optional Reason String.
@NotNull Mqtt5UserPropertiesBuilder.Nested<? extends Mqtt5PubAckBuilder>	userProperties()	Fluent counterpart of userProperties(Mqtt5UserProperties).
@NotNull Mqtt5PubAckBuilder	userProperties(@NotNull Mqtt5UserProperties userProperties)	Sets the User Properties.

Method Details

reasonCode

@NotNull
@NotNull Mqtt5PubAckBuilder reasonCode(@NotNull
 @NotNull Mqtt5PubAckReasonCode reasonCode)

Sets the Reason Code.

Parameters:

reasonCode - the Reason Code.

Returns:

the builder.

reasonString

@NotNull
@NotNull Mqtt5PubAckBuilder reasonString(@Nullable
 @Nullable String reasonString)

Set the optional Reason String.

Parameters:

reasonString - the Reason String or null to remove any previously set Reason String.

Returns:

the builder.

reasonString

@NotNull
@NotNull Mqtt5PubAckBuilder reasonString(@Nullable
 @Nullable MqttUtf8String reasonString)

Set the optional Reason String.

Parameters:

reasonString - the Reason String or null to remove any previously set Reason String.

Returns:

the builder.

userProperties

@NotNull
@NotNull Mqtt5PubAckBuilder userProperties(@NotNull
 @NotNull Mqtt5UserProperties userProperties)

Sets the User Properties.

Parameters:

userProperties - the User Properties.

Returns:

the builder.

userProperties

@CheckReturnValue
@NotNull Mqtt5UserPropertiesBuilder.Nested<? extends Mqtt5PubAckBuilder> userProperties()

Fluent counterpart of userProperties(Mqtt5UserProperties).

Calling Mqtt5UserPropertiesBuilder.Nested.applyUserProperties() on the returned builder has the effect of extending the current User Properties.

Returns:

the fluent builder for the User Properties.

See Also:

• userProperties(Mqtt5UserProperties)