Class MQTTMessage
- java.lang.Object
-
- software.amazon.awssdk.aws.greengrass.model.MQTTMessage
-
- All Implemented Interfaces:
EventStreamJsonMessage
public class MQTTMessage extends Object implements EventStreamJsonMessage
-
-
Field Summary
Fields Modifier and Type Field Description static String
APPLICATION_MODEL_TYPE
static MQTTMessage
VOID
-
Constructor Summary
Constructors Constructor Description MQTTMessage()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object rhs)
String
getApplicationModelType()
Returns the named model type.String
getContentType()
(Optional) Message content type.byte[]
getCorrelationData()
(Optional) Correlation data blob for request/response.Long
getMessageExpiryIntervalSeconds()
(Optional) Message expiry interval in seconds.byte[]
getPayload()
(Optional) The message payload as a blob.PayloadFormat
getPayloadFormat()
String
getPayloadFormatAsString()
(Optional) Message payload format.String
getResponseTopic()
(Optional) Response topic for request/response.String
getTopicName()
The topic to which the message was published.List<UserProperty>
getUserProperties()
(Optional) MQTT user properties associated with the message.int
hashCode()
Boolean
isRetain()
(Optional) The value of the retain flag.void
setContentType(String contentType)
(Optional) Message content type.void
setCorrelationData(byte[] correlationData)
(Optional) Correlation data blob for request/response.void
setMessageExpiryIntervalSeconds(Long messageExpiryIntervalSeconds)
(Optional) Message expiry interval in seconds.void
setPayload(byte[] payload)
(Optional) The message payload as a blob.void
setPayloadFormat(String payloadFormat)
(Optional) Message payload format.void
setPayloadFormat(PayloadFormat payloadFormat)
(Optional) Message payload format.void
setResponseTopic(String responseTopic)
(Optional) Response topic for request/response.void
setRetain(Boolean retain)
(Optional) The value of the retain flag.void
setTopicName(String topicName)
The topic to which the message was published.void
setUserProperties(List<UserProperty> userProperties)
(Optional) MQTT user properties associated with the message.MQTTMessage
withContentType(String contentType)
(Optional) Message content type.MQTTMessage
withCorrelationData(byte[] correlationData)
(Optional) Correlation data blob for request/response.MQTTMessage
withMessageExpiryIntervalSeconds(Long messageExpiryIntervalSeconds)
(Optional) Message expiry interval in seconds.MQTTMessage
withPayload(byte[] payload)
(Optional) The message payload as a blob.MQTTMessage
withPayloadFormat(String payloadFormat)
(Optional) Message payload format.MQTTMessage
withPayloadFormat(PayloadFormat payloadFormat)
(Optional) Message payload format.MQTTMessage
withResponseTopic(String responseTopic)
(Optional) Response topic for request/response.MQTTMessage
withRetain(Boolean retain)
(Optional) The value of the retain flag.MQTTMessage
withTopicName(String topicName)
The topic to which the message was published.MQTTMessage
withUserProperties(List<UserProperty> userProperties)
(Optional) MQTT user properties associated with the message.-
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.eventstreamrpc.model.EventStreamJsonMessage
fromJson, isVoid, postFromJson, toPayload
-
-
-
-
Field Detail
-
APPLICATION_MODEL_TYPE
public static final String APPLICATION_MODEL_TYPE
- See Also:
- Constant Field Values
-
VOID
public static final MQTTMessage VOID
-
-
Method Detail
-
getTopicName
public String getTopicName()
The topic to which the message was published.
-
setTopicName
public void setTopicName(String topicName)
The topic to which the message was published.
-
withTopicName
public MQTTMessage withTopicName(String topicName)
The topic to which the message was published.
-
getPayload
public byte[] getPayload()
(Optional) The message payload as a blob.
-
setPayload
public void setPayload(byte[] payload)
(Optional) The message payload as a blob.
-
withPayload
public MQTTMessage withPayload(byte[] payload)
(Optional) The message payload as a blob.
-
isRetain
public Boolean isRetain()
(Optional) The value of the retain flag.
-
setRetain
public void setRetain(Boolean retain)
(Optional) The value of the retain flag.
-
withRetain
public MQTTMessage withRetain(Boolean retain)
(Optional) The value of the retain flag.
-
getUserProperties
public List<UserProperty> getUserProperties()
(Optional) MQTT user properties associated with the message.
-
setUserProperties
public void setUserProperties(List<UserProperty> userProperties)
(Optional) MQTT user properties associated with the message.
-
withUserProperties
public MQTTMessage withUserProperties(List<UserProperty> userProperties)
(Optional) MQTT user properties associated with the message.
-
getMessageExpiryIntervalSeconds
public Long getMessageExpiryIntervalSeconds()
(Optional) Message expiry interval in seconds.
-
setMessageExpiryIntervalSeconds
public void setMessageExpiryIntervalSeconds(Long messageExpiryIntervalSeconds)
(Optional) Message expiry interval in seconds.
-
withMessageExpiryIntervalSeconds
public MQTTMessage withMessageExpiryIntervalSeconds(Long messageExpiryIntervalSeconds)
(Optional) Message expiry interval in seconds.
-
getCorrelationData
public byte[] getCorrelationData()
(Optional) Correlation data blob for request/response.
-
setCorrelationData
public void setCorrelationData(byte[] correlationData)
(Optional) Correlation data blob for request/response.
-
withCorrelationData
public MQTTMessage withCorrelationData(byte[] correlationData)
(Optional) Correlation data blob for request/response.
-
getResponseTopic
public String getResponseTopic()
(Optional) Response topic for request/response.
-
setResponseTopic
public void setResponseTopic(String responseTopic)
(Optional) Response topic for request/response.
-
withResponseTopic
public MQTTMessage withResponseTopic(String responseTopic)
(Optional) Response topic for request/response.
-
getPayloadFormat
public PayloadFormat getPayloadFormat()
-
getPayloadFormatAsString
public String getPayloadFormatAsString()
(Optional) Message payload format.
-
setPayloadFormat
public void setPayloadFormat(String payloadFormat)
(Optional) Message payload format.
-
withPayloadFormat
public MQTTMessage withPayloadFormat(String payloadFormat)
(Optional) Message payload format.
-
setPayloadFormat
public void setPayloadFormat(PayloadFormat payloadFormat)
(Optional) Message payload format.
-
withPayloadFormat
public MQTTMessage withPayloadFormat(PayloadFormat payloadFormat)
(Optional) Message payload format.
-
getContentType
public String getContentType()
(Optional) Message content type.
-
setContentType
public void setContentType(String contentType)
(Optional) Message content type.
-
withContentType
public MQTTMessage withContentType(String contentType)
(Optional) Message content type.
-
getApplicationModelType
public String getApplicationModelType()
Description copied from interface:EventStreamJsonMessage
Returns the named model type. May be used for a header.- Specified by:
getApplicationModelType
in interfaceEventStreamJsonMessage
- Returns:
- the named model type
-
-