RetainedPublish (HiveMQ Extension SDK 4.5.6 API)

All Superinterfaces:: Publish

@DoNotImplement
public interface RetainedPublish
extends Publish

Since:: 4.0.0, CE 2019.1

Method Summary

All Methods Static Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`static @NotNull RetainedPublishBuilder`	`builder()`	Deprecated. Use `Builders.retainedPublish()` instead
`default boolean`	`getRetain()`	If `true` this message is a retained message, for `false` this is just a normal publish.

Methods inherited from interface com.hivemq.extension.sdk.api.services.publish.Publish
getContentType, getCorrelationData, getMessageExpiryInterval, getPayload, getPayloadFormatIndicator, getQos, getResponseTopic, getTopic, getUserProperties

- Method Detail
  - builder
```
@Deprecated(since="4.4.0")
@NotNull
static @NotNull RetainedPublishBuilder builder()
```
    Deprecated.
    Use Builders.retainedPublish() instead
    
    Returns:
    
    A new RetainedPublishBuilder to create a retained publish.
    
    Since:
    
    4.0.0, CE 2019.1
  - getRetain
```
default boolean getRetain()
```
    If true this message is a retained message, for false this is just a normal publish.
    
    Specified by:
    
    getRetain in interface Publish
    
    Returns:
    
    The retain flag.
    
    Since:
    
    4.0.0, CE 2019.1