com.hivemq.client.mqtt.mqtt5.message.publish.pubcomp

Interface Mqtt5PubCompBuilder

@DoNotImplement
public interface Mqtt5PubCompBuilder

Builder for a Mqtt5PubComp.

Since:

1.0

Method Summary

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

Method Detail

reasonString

@NotNull
@NotNull Mqtt5PubCompBuilder 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 Mqtt5PubCompBuilder 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 Mqtt5PubCompBuilder userProperties(@NotNull
                                                     @NotNull Mqtt5UserProperties userProperties)

Sets the User Properties.

Parameters:

userProperties - the User Properties.

Returns:

the builder.

userProperties

@CheckReturnValue
Mqtt5UserPropertiesBuilder.Nested<? extends Mqtt5PubCompBuilder> 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)

getReasonCode

@NotNull
@NotNull Mqtt5PubCompReasonCode getReasonCode()

Returns:

the Reason Code of the PubComp message.